Get an event definition
Retrieve the definition of a specific behavioral event in your HubSpot account by providing the event name. This endpoint returns detailed information about the event type, including its properties and associations.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique name of the event definition to retrieve.
Response
successful operation
A boolean indicating whether the event type is archived.
An array of association definitions related to the event type.
A string representing the fully qualified name of the event type.
A string representing the unique identifier of the event type.
A string representing the name of the event type.
A string representing the object type ID associated with the event type.
An array of property objects associated with the event type.
A string representing the date and time when the event type was created, in ISO 8601 format.
An integer representing the ID of the user who created the event type.
A string providing a description of the event type.
The rendering template for the body of the CRM timeline activity card.
The rendering template for the header of the CRM timeline activity card.
A string representing the primary object associated with the event type.
A string representing the ID of the primary object associated with the event type.
A string indicating the tracking type of the event. Valid values include 'VISITED_URL', 'CLICKED_ELEMENT', 'CUSTOM_SCRIPT', 'MANUAL', 'IMPORT', 'PROPERTY_CHANGE', 'COMBO_EVENT'.
APP_EVENT, AUTOCAPTURE_EVENT, CLICKED_ELEMENT, COMBO_EVENT, CUSTOM_SCRIPT, CUSTOM_SIGNAL, IMPORT, MANUAL, POLLING, PROPERTY_CHANGE, VISITED_URL, WEBHOOK A string representing the date and time when the event type was last updated, in ISO 8601 format.
An integer representing the ID of the user who last updated the event type.