New Integration of Custom Events with Custom Objects
Starting April 4th, 2024, we are introducing an update to our Custom Objects API that enables the creation and association of Custom Events with Custom Objects. This enhancement allows developers to capture unique business actions directly within HubSpot, offering a more tailored data model that aligns closely with specific business needs.
What's changing?
Developers can now associate Custom Events with Custom Objects through the Custom Events interface within HubSpot or programmatically via the API.
Creating Custom Events in HubSpot:
- Navigate to Reports > Data Management > Custom Events > click the "create event" button, and select the type of event you need.
- Provide a name for your event, add a description (optional), and select your Custom Object using the "associated object" dropdown.
- Define your event properties, save the event, and use the provided event ID in your API calls.
Creating Custom Events via API:
- Utilize the Event Definitions API to specify your Custom Object as the
primaryObject
and outline the desired event properties. - Use the send Event Completions API to dispatch your event completion. Ensure you include the HubSpot object record ID in your event data to link the event to the correct Custom Object record.
Immutable Associations:
This association cannot be modified once an event is ingested and associated with a Custom Object record.Custom Events connected to Custom Objects empower developers to construct a highly customized data model within HubSpot. This capability captures business-specific actions and their direct association with relevant Custom Objects, enhancing data management and utilization in tailored applications and workflows.
Questions or comments? Join us in the developer forums.