v4
latestOpenAPI 3.0.12026-07-131067109.8 KBBasic
post/events/custom/2026-09/event-definitions
Request body
descriptionstring
A description of the event that will be shown as help text in HubSpot.
includeDefaultPropertiesboolean required
labelstring required
Human readable label for the event. Used in HubSpot UI
namestring
Internal event name, which must be used when referencing the event from this event definitions API. If a name is not supplied, one will be generated based on the label. The name value will also be used to automatically generate a fullyQualifiedName for the event definition, which you'll use when sending event completions to this event.
primaryObjectstring
The object type to associate this event to. Can be one of CONTACT, COMPANY, DEAL, TICKET. If no primaryObject is supplied, we will default to associating the event to CONTACT objects.
Response
successful operation
archivedboolean required
createdAtstring date-time
createdUserIdinteger
descriptionstring
fullyQualifiedNamestring required
idstring required
namestring required
objectTypeIdstring required
primaryObjectstring
primaryObjectIdstring
trackingType'APP_EVENT' | 'AUTOCAPTURE_EVENT' | 'CLICKED_ELEMENT' | 'COMBO_EVENT' | 'CUSTOM_SCRIPT' | 'IMPORT' | 'MANUAL' | 'PROPERTY_CHANGE' | 'VISITED_URL' | 'WEBHOOK'
updatedAtstring date-time
updatedUserIdinteger