HUhubspot
Basic

Create

Changed on

Create a new behavioral event definition in your HubSpot account. This endpoint allows you to define the structure and properties of a new behavioral event, which can then be used to track specific user actions or behaviors. The request body must include the necessary event details and property definitions.

post/events/2026-09/event-definitions

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/events/2026-09/event-definitions
  • 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

Request body

descriptionstring

A string providing a description of the event type.

includeDefaultPropertiesboolean required

A boolean indicating whether default properties should be included.

labelstring required

A string representing the label of the event type.

namestring

A string representing the name of the event type.

primaryObjectstring

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

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