HUhubspot
Basic

Retrieve a custom event definition

Changed on

Fetch a single custom event definition by name.

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

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/events/2026-03/event-definitions/{eventName}
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Path parameters

eventNamestring required

Response

successful operation

archivedboolean required
createdAtstring date-time
createdUserIdinteger
descriptionstring
detailTemplatestring
fullyQualifiedNamestring required
headerTemplatestring
idstring required
namestring required
objectTypeIdstring required
primaryObjectstring
primaryObjectIdstring
trackingType'APP_EVENT' | 'AUTOCAPTURE_EVENT' | 'CLICKED_ELEMENT' | 'COMBO_EVENT' | 'CUSTOM_SCRIPT' | 'CUSTOM_SIGNAL' | 'IMPORT' | 'MANUAL' | 'PROPERTY_CHANGE' | 'VISITED_URL' | 'WEBHOOK'
updatedAtstring date-time
updatedUserIdinteger

Changes

Some revisions have not been checked yet.