Create
Create a media played event in the HubSpot account. This endpoint is used to log when media content has been played, which can be useful for tracking user engagement with media resources.
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 that was played, such as 'VIDEO', 'AUDIO', 'DOCUMENT', 'OTHER', or 'IMAGE'.
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO The timestamp when the media play event occurred, in Unix time format.
A unique identifier for the session during which the media was played.
The state of the media play event, indicating the current status.
STARTED, VIEWED An encoding parameter used internally by HubSpot.
The unique identifier for the contact associated with the media play event.
The unique tracking key for the contact, used for tracking purposes.
An external identifier for the media, used to correlate with external systems.
Additional context about the media play event, provided by external systems.
EMAIL, EXTERNAL_PAGE The URL of the iframe containing the media, if applicable.
A unique identifier for the media bridge instance.
The name of the media that was played.
The URL of the media that was played.
A unique identifier for the page where the media was played.
The name of the page where the media was played.
The URL of the page where the media was played.
Response
successful operation
The unique identifier for the contact associated with this media event.
The unique identifier for the media bridge instance associated with this event.
Coordinates that specify the location or context of the media bridge object.
The type identifier of the media bridge object involved in the event.
The name of the media content that was played.
The type of media that was played, such as video or audio.
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO A Unix timestamp in milliseconds indicating when the media play event occurred.
The unique identifier of the HubSpot portal where the event occurred.
The unique identifier for the media provider.
The unique identifier for the session during which the media was played.
The state of the media play event, such as 'started' or 'completed'.
STARTED, VIEWED Additional context provided by external systems about the play event.
EMAIL, EXTERNAL_PAGE The URL of the iframe where the media was embedded and played.
The URL where the media content is hosted.
The unique identifier for the page where the media was played.
The name of the page where the media was played.
Coordinates that specify the location or context of the page object.
The URL of the page where the media was played.