topic New Integration of Custom Events with Custom Objects in Developer Announcements

New Integration of Custom Events with Custom Objects

hseligson — Fri, 19 Apr 2024 13:52:44 GMT

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 other HubSpot developers in our peer-to-peer community below to discuss feedback, concerns, and best practices.

Re: New Integration of Custom Events with Custom Objects

zach_threadint — Thu, 18 Apr 2024 23:11:27 GMT

Hi @hseligson 👋

As an app developer, I'm really excited for this update 🙂

However, I'm having trouble creating a custom event definition for a custom object. I can't see where I'm going wrong and the API error response I'm receiving is not particularly helpful. Can you (or anyone in the community!) see where I'm going wrong?

POST https://api.hubapi.com/events/v3/event-definitions

{ "name": "example_name", "description": "Example description", "label": "Example label", "primaryObject": "CUSTOMOBJECT", // my custom object's "name" "propertyDefinitions": [ { "name": "example_date_one", "label": "Example Date 1", "type": "datetime", "description": "Example description" }, { "name": "example_date_two", "label": "Example Date 2", "type": "datetime", "description": "Example description" }, { "name": "example_number_one", "label": "Example Number 1", "type": "number", "description": "Example description" }, { "name": "example_number_two", "label": "Example Number 2", "type": "number", "description": "Example description" }, { "name": "example_number_three", "label": "Example Number 3", "type": "number", "description": "Example description" } ] }

Error response:

{ "status": "error", "message": "internal error", "correlationId": "xxx-yyy" }

I've triple-checked my authentication as valid and having the correct scopes.

Furthermore, my request works if I use a standard object type (e.g. CONTACT) instead of my custom object type name. I also tried using my custom object's fully qualified name and object type ID, with no luck.

Any help you could offer would be greatly appreciated 🙂

On a side note, I noticed there are a few broken links in the announcement post -- looks like links have been directed to the "community" subdomain instead of the "developers" subdomain for a few of those API doc links.

Re: New Integration of Custom Events with Custom Objects

hseligson — Fri, 19 Apr 2024 14:10:08 GMT

Hi @zach_threadint 👋 thank you for reaching out and sharing your feedback!
I also appreciate the note about the links - these have been updated.

Hmm, you've already tried what I would suggest:
I also tried using my custom object's fully qualified name and object type ID, with no luck.
I'm going to reach out internally and see if our tech lead can provide some insight or look into this. I will follow up with you as soon as I'm able to get some feedback. Apologies for the inconvenience!

Re: New Integration of Custom Events with Custom Objects

zach_threadint — Sat, 20 Apr 2024 01:09:47 GMT

Thanks @hseligson 🙂

Re: New Integration of Custom Events with Custom Objects

hseligson — Mon, 22 Apr 2024 18:02:35 GMT

Hey @zach_threadint - Great news! We have successfully identified the issue that you reported to us and we truly appreciate you bringing it to our attention. This issue could have potentially affected other customers as well if it had not already done so.

The problem was caused by the character length of the name, which we had set to a maximum of 10 characters. We are now working on changing this to at least 12 characters. We are submitting a PR to rectify this issue as soon as possible.

Once the change has been implemented, I will follow up with you to confirm that the issue has been resolved. Thank you for your patience and understanding!

Re: New Integration of Custom Events with Custom Objects

zach_threadint — Tue, 23 Apr 2024 00:53:53 GMT

Hi @hseligson 👋

Thanks for the update. The custom object name I was testing with only had 9 characters 🤔 Regardless, looking forward to testing again once the issue has been resolved.

Re: New Integration of Custom Events with Custom Objects

hseligson — Tue, 23 Apr 2024 13:46:44 GMT

Hi @zach_threadint - Apologies, the issue stemmed from the custom object ID exceeding the maximum character limit set in our database, not the custom object name. Specifically, the custom object ID you tried to create was longer than the 10-character limit we originally designed for storing these IDs.
To address this, we updated our database schema to support object IDs of up to 20 characters, ensuring compatibility with larger IDs.
Unfortunately, I'm currently unable to test this with a similarly high ID as we encountered with your entry, since these are generated based on system events and are not manually controllable. However, we expect this change will resolve the issue. Should you have any questions or require further assistance, please don't hesitate to reach out!

Re: New Integration of Custom Events with Custom Objects

zach_threadint — Tue, 23 Apr 2024 21:47:37 GMT

That seems to have done the trick. Thanks @hseligson 😄