Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions src/provider-guides/hubspot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,32 @@ The connector supports reading from:
The connector supports reading from:
- [meeting-links](https://developers.hubspot.com/docs/api-reference/latest/scheduler/meetings/get-meeting-links)

#### Event Occurrences
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add a couple of lines about what events do at the beginning? i.e. an event is captured during form submissions, mail delivery, sequence changes, etc. This will help builders understand the relevance of events to their use case. Especially since HubSpot has used interchanging functionality in the past for it.


Event occurrences represent specific actions captured at a point in time, such as form submissions, email delivery,
sequence activity, and other **behavioral changes**. They are useful to understand when an event
happened and how that event may relate to automation or downstream workflows.

To find the "event type" name, use the HubSpot Events API's
[list event types endpoint](https://developers.hubspot.com/docs/api-reference/latest/events/retrieve-events/get-event-types)
and [list custom event definitions](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/create-event-definition).
Standard event type names begin with `e_`, while customer-specific custom event definitions use the `fullyQualifiedName` property with a `pe{HubId}_` prefix.
Standard events are safe to use across all customers,
while custom event definitions apply only to the specific customer account where they are defined.

The HubSpot connector exposes event occurrences as **connector-defined objects**
named using the prefix `AMPERSAND-event-occurrences-` followed by the "event type" name.
<Note>
Note that **occurrences** is spelled with two c's and two r's, which is easy to miss.
</Note>

Naming rule: `AMPERSAND-event-occurrences-<EVENT_TYPE>`:
* AMPERSAND-event-occurrences-e_call_ended
* AMPERSAND-event-occurrences-e_form_submission
* AMPERSAND-event-occurrences-e_mta_bounced_email_v2
* AMPERSAND-event-occurrences-e_visited_page
* AMPERSAND-event-occurrences-pe148543157_this_is_my_event

#### Reading users and owners

To read users from your customer's HubSpot workspace, enable the `crm.objects.users.read` scope and add `users` as an object in `amp.yaml`:
Expand Down
Loading