Create Event
Create a new attention span event in the MediaBridgeService. This endpoint is used to record attention span events, which can be useful for tracking user engagement with media content. The request must include a valid JSON body conforming to the AttentionSpanEventRequest schema.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
The type of media involved in the event. Valid values include 'VIDEO', 'AUDIO', 'DOCUMENT', 'OTHER', and 'IMAGE'.
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO The timestamp when the event occurred, represented as a Unix timestamp in milliseconds.
A map of raw data key-value pairs providing additional context about the event.
The unique identifier for the session during which the event occurred.
An encoded string used for HubSpot-specific encoding purposes.
The unique identifier for the contact associated with the event.
The unique tracking key for the contact, used for tracking purposes.
An external identifier for the event, typically used to correlate with external systems.
Additional context about the play event, typically used for external integrations.
EMAIL, EXTERNAL_PAGE The unique identifier for the media bridge instance.
The name of the media involved in the event.
The URL of the media involved in the event.
The unique identifier for the page where the event occurred.
The name of the page where the event occurred.
The URL of the page where the event occurred.
A raw data string containing additional information about the event.
Response
successful operation
A string representing the unique identifier for the contact associated with the event.
A string representing the unique identifier for the media bridge instance.
A string detailing the coordinates of the media bridge object.
A string representing the type identifier for the media bridge object.
A string representing the name of the media content.
A string indicating the type of media involved in the event, such as 'VIDEO', 'AUDIO', etc.
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO A string representing the timestamp of when the event occurred, in ISO 8601 format.
A string indicating the range of percentages that were played during the session.
An integer representing the unique identifier for the HubSpot portal.
A string representing the unique identifier for the media provider.
A string representing the unique identifier for the session during which the media was played.
A number indicating the total percentage of the media that was played.
A string providing additional context about the play event from an external source.
EMAIL, EXTERNAL_PAGE A string containing the URL of the media content.
A string representing the unique identifier for the page.
A string representing the name of the page where the media was accessed.
A string detailing the coordinates of the page object.
A string containing the URL of the page where the media was accessed.
A string containing raw data associated with the event.
A number representing the total seconds of media that were played.