Custom Behavioral Events

• Manually tracked behavioral events are custom events that are unique to your business that are not captured automatically by HubSpot or by an integration. You can manually send data to these events through this API.

Below, learn how to create a manually tracked custom behavioral event, send event data through the API, and to use event data once captured.

To set up your event, first create the event in HubSpot. When creating the event, HubSpot will include a set of default event properties that you can use to store event data. You can also create additional properties for the event. These properties can be created or edited at any time. 

Once you’ve set up your event, you can send data to it through the API.

To send event data to HubSpot, make a POST request to https://api.hubspot.com/events/v3/send. There is a limit of 30 million custom behavioral events that can be logged per month in your account.

In the request body, you'll need to include event information as well as a contact to associate the event completion with. The following fields are required when triggering a custom behavioral event:

• Identifier: Either the contact ID, email, or utk of the contact associated with the event.
• Event name: the internal name of the event, which can be found in HubSpot. Learn how to find an event's internal name. 

Send property data

To include specific properties in the request body, use the following format:

The values you send will depend on the type of event property. Most of the default event properties are single-line text (string). However, you can create custom properties of any type for each event. Review the table below when formatting property values.

To view an event's available properties:

• In HubSpot, navigate to Reports > Analytics Tools.
• Click Custom Behavioral Events.
• Click the name of the event.
• Click the Properties tab.
• In the properties table, view the property type under the name of the property. 

Set the time of an event

To specify the time of event completion, you can include a timestamp in an occurredAt field in your request. By default, if you do not include this field, HubSpot will set the completion time as the time of sending the request. The occurredAt field can be helpful if you want to store a different timestamp than when the API itself fired. For example, you have an event Attended Partner Webinar. The webinar took place two weeks ago, but you only received the data today. You could set the occuredAt property to include a timestamp from two weeks ago, which will set those dates in HubSpot accordingly.

Example request body

Below is an example request body for a login event which sends city, country, page, and interaction source data to HubSpot. The contact that completed the event is represented by the objectId field. For more details on sending event data, click the Endpoints tab at the top of this article.

To retrieve a contact's event data, make a GET request to /events/v3/events/eventType={EVENT_NAME}&objectType=contact&objectId={CONTACT_ID}. 

The above request includes:

• eventType: the internal name of the event.
• objectType: the record's object type.
• objectId: the contact's ID.

JavaScript events such as clicked element and visited URL events are automatically populated with asset type and interaction data for attribution reporting. To include the same data for manually tracked behavioral events, you'll need to manually include the data in the request body using event properties. Learn more about analyzing custom behavioral events.

Below, learn about the available values for asset types and interaction sources, along with example requests. 

To attribute a specific asset type to a custom behavioral event request, include the hs_page_content_type property in the request body. For example:

HubSpot's standard content types, such as landing pages and blog posts, can be represented with the following values:

For all other types of assets, use the following values:

To attribute a custom behavioral event to an asset, include the hs_page_title or hs_asset_title property in your request with the name of the asset formatted as a string. For example:

hs_page_title:

To attribute a custom behavioral event to a specific source, include the hs_touchpoint_source property in your request with one of the following values: