Marketing Events

A marketing event is a CRM object, similar to contacts and companies, that enables you to track and associate marketing events, such as a webinar, with other HubSpot CRM objects. Below, learn more about working with the marketing event API to integrate marketing events into an app.

• Scope requirements
• Event attendance endpoints
• Configure app settings
  • Step 1: Create an API in your app
  • Step 2: Provide HubSpot with the URL path to your API

To make an API request to one of the marketing event endpoints, the following scopes are required:

• crm.objects.marketing_events.read: grants permission to retrieve marketing event and attendance data.
• crm.objects.marketing_events.write: grants permission to create, delete, or make changes to marketing event information.

When authenticating calls made by your app, you can either use a private app access token or OAuth. Learn more about authentication methods. For the full list of endpoints available, click the Endpoints tab at the top of this article.

The event attendance state endpoints allow you to record a subscription state between a HubSpot contact and a marketing event. For example, you can use this endpoint to record that a HubSpot contact has registered for a marketing event.

There are two endpoints you can use to update a contact's attendance status. If you were previously using the /upsert or /email-upsert endpoints to update an attendee's status, you can instead use the endpoints listed below to maintain the same functionality while also populating the contact's attendance duration on the contact timeline:

• If you want to use the contact IDs of existing contacts:
  • Make a POST request to /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create, using the ID of the event from your external application as the externalEventId.
  • In the request body, provide an inputs object that includes the following fields:
    • interactionDateTime: the date and time at which the contact subscribed to the event.
    • vid: the contact ID of an existing contact.
• If you want to use the email address of one of the event's attendees:
  • Make a POST request to /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create.
  • In the request body, provide an inputs object that includes the following fields:
    • interactionDateTime: the date and time at which the contact subscribed to the event.
    • email: the email address of the attendee as the value of the email field within an inputs 
  • If the email address you include don't match the address of an existing contact, a new contact will be created.

For both of the endpoints above, provide the following values for the corresponding path parameters:

• externalEventId: the ID of the marketing event.
•  subscriberState: an enumeration that matches the new attendance status of the contact:
  • REGISTERED: indicates that the HubSpot contact has registered for the event.
  • ATTENDED: indicates that the HubSpot contact has attended the event. If you're updating a contact's status to ATTENDED, you can also include the joinedAt and leftAt timestamps as parameters in the request body, specified in the ISO8601 Instant format.
  • CANCELLED: indicates that the HubSpot contact, who had previously registered for the event, has cancelled their registration.

Once your event has completed, you can mark the event as complete and calculate attendance metrics (e.g., duration of attendance for all attendees) by making a POST request to /marketing/v3/marketing-events/events/{externalEventId}/complete. Note this action is irreversible, so you should only invoke this endpoint once all attendance state change events have already occurred. 

There's some setup required to allow marketing events to sync properly with HubSpot.

If you send HubSpot a subscriber state change (e.g., a registration or cancellation), HubSpot will first check to see if a Marketing Event exists for the specified event ID. If it doesn't, HubSpot will call the configured endpoint for your app to retrieve the details of the marketing event, then create the event in HubSpot and then publish the subscriber state change.

This is provided for convenience; however, it's still recommended that you create the Marketing Events yourself via the CRUD methods provided in the Endpoints tab at the top of this article, and don't rely on this functionality to create your marketing events in HubSpot.

In order to support this, HubSpot requires each app that uses Marketing Events to define an API to fetch information about a specific marketing event.

Requirements:

• Accepts:
  • externalAccountId: a query parameter that specifies the accountId of the customer in the external app.
  • appId: a query parameter that specifies the ID of the HubSpot application that is requesting the event details. This will be the ID of your app.
  • externalEventId: a path parameter in the URL of the request that specifies the ID of the event in the external app that HubSpot requires details about.
• Returns:
  • A JSON object that provides details for the marketing event, that includes the following fields detailed in the table below:

HubSpot will also send a X-HubSpot-Signature-v3 header that you can use to verify that the request came from HubSpot. Read more about request signatures for additional details on the signature and how to validate it.

Now that you've created the API in your app that will return an object that provides the details of a specific marketing event, you will need to provide HubSpot with the URL path to your API by making a POST request to /marketing/v3/marketing-events/{appId}/settings. This will allow HubSpot to determine how to make requests to your app to get the details of a marketing event.

In the body of your POST request, specify your URL using the eventDetailsURL field. The eventDetailsURL must adhere to the following two requirements:

• Contain a %s character sequence, which HubSpot will use to substitute in the ID of the event (externalEventId) as a path parameter.
• It must be the full path to the API resource, including the https:// prefix and the domain name (e.g., my.event.app).

For example, if you configure an eventDetailsURL of https://my.event.app/events/%s, and you need to make a request to fetch details of an event with id 1234-event-XYZ, for the HubSpot app with id app-101 and account with id ABC-account-789, HubSpot will make a GET request to:

https://my.event.app/events/1234-event-XYZ?appId=app-101&externalAccountId=ABC-account-789