v4
latestOpenAPI 3.0.12026-07-131067110.7 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 for display in HubSpot's UI.
namestring
Internal event name, which must be used when referencing the event from the API. If a name is not supplied, one will be generated based on the label. The name does not include the pe<PORTAL_ID>_ prefix used when sending event completions.
primaryObjectstring
The object type to associate this event to. Can be one of CONTACT, COMPANY, DEAL, TICKET. If no value is supplied, will default to CONTACT.
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