Skip to content

[ENG-3949] feat(hubspot): Event Occurrences#619

Open
Cobalt0s wants to merge 2 commits into
mainfrom
cobalt0s/hubspot-events
Open

[ENG-3949] feat(hubspot): Event Occurrences#619
Cobalt0s wants to merge 2 commits into
mainfrom
cobalt0s/hubspot-events

Conversation

@Cobalt0s
Copy link
Copy Markdown
Contributor

@Cobalt0s Cobalt0s commented May 29, 2026

image

@linear
Copy link
Copy Markdown

linear Bot commented May 29, 2026

ENG-3949

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 29, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Ampersand 🟢 Ready View Preview May 29, 2026, 11:17 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@Cobalt0s Cobalt0s self-assigned this May 29, 2026
@Cobalt0s Cobalt0s marked this pull request as ready for review May 29, 2026 23:16
@Cobalt0s Cobalt0s requested a review from RajatPawar May 29, 2026 23:35
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.

Comment thread src/provider-guides/hubspot.mdx Outdated
* AMPERSAND-event-occurrences-e_mta_bounced_email_v2
* AMPERSAND-event-occurrences-e_visited_page

Where to get the event type name: event type identifiers are returned by the Events API's [event types endpoint](https://developers.hubspot.com/docs/api-reference/latest/events/retrieve-events/get-event-types).
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.

  1. I'd move this before the naming rule and probably run it by an LLM to tighten up the wording
  2. Could you also mention that e_ events are mostly standard, and a_ may be custom, and that e_ events are therefore generally safe to use across consumers?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed all the comments in this commit: e823ed6

I have not found evidence that a_ signifies as custom object. However I did create the custom definition and sent some custom events.

The API behavriour summary:

  1. Creating custom event definition.
POST /events/2026-03/event-definitions {
    "label": "This is my event",
    "includeDefaultProperties": true,
    "propertyDefinitions": []
}
  1. Listing definitions.
GET /events/2026-03/event-definitions:
 "results": [
        {
            "labels": {
                "singular": "This is my event",
                "plural": "This is my event"
            },
            "name": "this_is_my_event",
            "id": "203766427",
            "fullyQualifiedName": "pe148543157_this_is_my_event",
         }
]
  1. Push some events.
POST /events/2026-03/send {
  "eventName": "pe148543157_this_is_my_event",
  "objectId": "783099041997",
  "properties": {}
}
  1. Query these custom events.
Image

Comment thread src/provider-guides/hubspot.mdx Outdated
* AMPERSAND-event-occurrences-e_mta_bounced_email_v2
* AMPERSAND-event-occurrences-e_visited_page

Where to get the event type name: event type identifiers are returned by the Events API's [event types endpoint](https://developers.hubspot.com/docs/api-reference/latest/events/retrieve-events/get-event-types).
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.

Could we add a sample integration for a timeline usecase? i.e. capturing notes, calls, a few marketing events and campaigns?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is present in the samples repo: https://github.com/amp-labs/samples/blob/94a3cf7778aa4a39121813cb6eefad47a2b5b28e/hubspot/amp.yaml#L89

Samples repo is always referenced from the docs:

For an example manifest file, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/hubspot/amp.yaml).

Do you want me to duplicate the definition

        - objectName: AMPERSAND-event-occurrences-e_form_view_v2
          mapToName: formViews
          mapToDisplayName: "Form Views"
          destination: defaultWebhook
          schedule: "*/10 * * * *"
          requiredFields:
            - fieldName: objectId
            - fieldName: objectType
          optionalFieldsAuto: all

Comment thread src/provider-guides/hubspot.mdx Outdated
* 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
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.

I would instruct builders to check the spelling if they receive errors when deploying it (there are two c and two rs in the spelling)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants