The API documentation here states the API response:
... includes standard events, such as website page views and email opens
Testing has confirmed that this API does not return email open events. In the HubSpot UI I can see that contact [ID] has opened an email. The call below returns many events, however none of these are email-open-events.
events/v3/events?objectId=128478427399&objectType=contact&limit=100
Is this a documentation bug, or an API issue. I understand that the v1 API can be used, however given that it is tagged as legacy we are reluctant to use it.
Moderation note: The HubSpot Community is a public space. I have therefore edited your content for security & confidentiality reasons.
Hi @TimMunro and thank you for raising this and sharing your findings with the HubSpot Community!
You’re right, the Event Analytics v3 API documentation does mention it includes standard events like website page views and email opens.
However, it looks like for email-specific events, there’s actually a dedicated (and still active) legacy Email Analytics v1 API that handles email opens, clicks, bounces, and more.
For now, I recommend using the legacy Email Analytics v1 API for tracking email opens, as it remains fully functional.
I’ll also be flagging this internally.
Thank you for your attention to detail, and let us know if you have any more questions!
Have a wonderful day!
Bérangère
This post was created with the assistance of AI tools
The legacy email event API only accepts the legacy numeric campaign_id which the v3 campaigns do not have. How can you use the legacy email event API to get a batch of events for a new campaign?
Hi @TimMunro and welcome, we are so glad to have you here!
Great question, thanks for asking!
So, the legacy email events API (/email/public/v1/events) relies on the numeric campaign_id from older campaigns, which isn’t available with the newer v3 campaigns that use a different type of identifier.
At the moment, there isn’t a direct way to connect v3 campaigns with the legacy email events API, since their identifier systems don’t match.
However, there are some alternative options you can explore:
- Event Analytics API (v3): You can query email events like opens on a per-contact basis using /events/v3/events/?objectType=contact&objectId={contactId}. This allows you to view events for individual CRM records.
- Campaigns API (v3): The updated Campaigns API (/marketing/v3/campaigns) offers detailed campaign data and asset associations, though it approaches event retrieval differently.
Since the v1 email events API is a legacy tool, the newer v3 campaigns weren’t built to work directly with it.
I hope it helps!
Bérangère
This post was created with the assistance of AI tools
As mentioned in the original post, our testing found that email events like opens are not presented in the /events/v3/events/?objectType=contact&objectId={contactId} endpoint.
Hi @TimMunro and thanks for your valuable feedback!
The Events v3 API (/events/v3/events/) is a great tool for tracking event analytics, including standard events such as website page views and email opens.
For more detailed email engagement activities like opens, clicks, prints, and forwards, HubSpot provides the Email Events API (v1) at /email/public/v1/events.
This email-specific API is the best choice for accessing rich engagement data, including properties like userAgent, browser, location, and open duration.
While Events v3 is ideal for custom behavioral events and general CRM analytics, it may not include all of the detailed email engagement events you’re looking for.
For these insights, the Email Events API is your go-to resource!
Please let me know if you have additional questions, I’d be happy to help!
Bérangère
This post was created with the assistance of AI tools
Hi @TimMunro, I wanted to get back to you to share that we heard your feedback, and we’ve made an update to this documentation: “Events API | Event Analytics”.
Thanks again for sharing your feedback with us. It helps improve HubSpot for our whole Community.
Have a wonderful day!
Bérangère
While Events v3 is ideal for custom behavioral events and general CRM analytics, it may not include all of the detailed email engagement events you’re looking for.
For these insights, the Email Events API is your go-to resource
However the legacy Email Events API does not recognize the UUIDs of the new campaigns so you can only get Email Events of campaigns prior to the switch over to v3. Which is worthless.
Tom
Hi @TomJenkins and thank you for sharing your experience with the Email Events API update.
For aggregate email performance data on newer campaigns, the Marketing Emails v3 API may be your best option.
And I have shared internally your feedback for granular per-recipient event data (opens, clicks, bounces) on newer campaigns using UUID-based IDs.
Thanks so much and have a great day!
Bérangère