HUhubspot
Basic

Retrieve event definition

Changed on

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.

get/events/2026-09/event-definitions/{eventName}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/events/2026-09/event-definitions/{eventName}
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: behavioral_events.event_definitions.read_write

Path parameters

eventNamestring required

The unique name of the event definition to retrieve.

Response

successful operation

archivedboolean required

A boolean indicating whether the event type is archived.

createdAtstring date-time

A string representing the date and time when the event type was created, in ISO 8601 format.

createdUserIdinteger

An integer representing the ID of the user who created the event type.

descriptionstring

A string providing a description of the event type.

detailTemplatestring

The rendering template for the body of the CRM timeline activity card.

fullyQualifiedNamestring required

A string representing the fully qualified name of the event type.

headerTemplatestring

The rendering template for the header of the CRM timeline activity card.

idstring required

A string representing the unique identifier of the event type.

namestring required

A string representing the name of the event type.

objectTypeIdstring required

A string representing the object type ID associated with the event type.

primaryObjectstring

A string representing the primary object associated with the event type.

primaryObjectIdstring

A string representing the ID of the primary object associated with the event type.

trackingType'APP_EVENT' | 'AUTOCAPTURE_EVENT' | 'CLICKED_ELEMENT' | 'COMBO_EVENT' | 'CUSTOM_SCRIPT' | 'CUSTOM_SIGNAL' | 'IMPORT' | 'MANUAL' | 'POLLING' | 'PROPERTY_CHANGE' | 'VISITED_URL' | 'WEBHOOK'

A string indicating the tracking type of the event. Valid values include 'VISITED_URL', 'CLICKED_ELEMENT', 'CUSTOM_SCRIPT', 'MANUAL', 'IMPORT', 'PROPERTY_CHANGE', 'COMBO_EVENT'.

updatedAtstring date-time

A string representing the date and time when the event type was last updated, in ISO 8601 format.

updatedUserIdinteger

An integer representing the ID of the user who last updated the event type.

Changes

  • 2026-09758db024626aRevision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status