New Events and updated Ecosystem and CMS APIs are now in Developer Preview
As we continue to build the next generation of HubSpot’s APIs to provide the consistency and completeness our developer community has requested, we are excited to announce that a net new API and several more updated APIs are now in developer preview.
A brand new Events API
Since the Analytics API was released in early 2018 developers have been able to retrieve their aggregated analytics report data, including page views, CTA clicks, form submissions, etc. However, some of our earliest feedback has turned out to be our most consistent: customers also need the API to provide their raw, unaggregated data.
Today, we are excited to introduce a new Events API, which features endpoints to retrieve event data for web activities such as page views and form submissions. The new endpoint allows developers to find and filter events associated with a CRM object (e.g. contacts, companies, deals, etc.) of any type. These events show the interactions the selected object has had within the HubSpot system. With this new API, developers will be able to:
- Build datasets for detailed custom analysis
- Present a timeline of a contact's web events in an external UI
Currently two events are supported
e_form_submissions with more to come in the near future.
Updated Ecosystem APIs
We’ve updated the Timeline, and Custom Cards API to be more consistent with our latest version of the CRM APIs. The biggest change comes to the Timeline API which is now treating events as immutable. This means that if an integration relies on being able to update an event, it should not be updated to this version of the API. We are currently considering alternatives to supporting integrations that currently rely on updating event information. Please join the conversation in the community if you are relying on this functionality.
Updated CMS APIs
The Domains, URL Redirects, and Site Search APIs have also been updated to be consistent with the latest version of the CRM APIs. Regardless of which system developers interact with, they can use the same patterns. We believe this is a big win for the usability of our APIs.
What this means for developers
Start testing out these endpoints. Developer preview is the perfect time to let us know what you think. We’ll be collecting and iterating quickly on your feedback, which could mean breaking changes. It’s not recommended to use these endpoints in a production environment yet, but we’ll let you know when they’re ready.
If you have any questions, please join the conversation in the community.