Skip to main content
POST
Create

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
mediaType
enum<string>
required

The type of media that was played, such as 'VIDEO', 'AUDIO', 'DOCUMENT', 'OTHER', or 'IMAGE'.

Available options:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required

The timestamp when the media play event occurred, in Unix time format.

sessionId
string
required

A unique identifier for the session during which the media was played.

state
enum<string>
required

The state of the media play event, indicating the current status.

Available options:
STARTED,
VIEWED
_hsenc
string

An encoding parameter used internally by HubSpot.

contactId
integer<int64>

The unique identifier for the contact associated with the media play event.

contactUtk
string

The unique tracking key for the contact, used for tracking purposes.

externalId
string

An external identifier for the media, used to correlate with external systems.

externalPlayContext
enum<string>

Additional context about the media play event, provided by external systems.

Available options:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string

The URL of the iframe containing the media, if applicable.

mediaBridgeId
integer<int64>

A unique identifier for the media bridge instance.

mediaName
string

The name of the media that was played.

mediaUrl
string

The URL of the media that was played.

pageId
integer<int64>

A unique identifier for the page where the media was played.

pageName
string

The name of the page where the media was played.

pageUrl
string

The URL of the page where the media was played.

Response

successful operation

contactId
integer<int64>
required

The unique identifier for the contact associated with this media event.

mediaBridgeId
integer<int64>
required

The unique identifier for the media bridge instance associated with this event.

mediaBridgeObjectCoordinates
string
required

Coordinates that specify the location or context of the media bridge object.

mediaBridgeObjectTypeId
string
required

The type identifier of the media bridge object involved in the event.

mediaName
string
required

The name of the media content that was played.

mediaType
enum<string>
required

The type of media that was played, such as video or audio.

Available options:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required

A Unix timestamp in milliseconds indicating when the media play event occurred.

portalId
integer<int32>
required

The unique identifier of the HubSpot portal where the event occurred.

providerId
integer<int32>
required

The unique identifier for the media provider.

sessionId
string
required

The unique identifier for the session during which the media was played.

state
enum<string>
required

The state of the media play event, such as 'started' or 'completed'.

Available options:
STARTED,
VIEWED
externalPlayContext
enum<string>

Additional context provided by external systems about the play event.

Available options:
EMAIL,
EXTERNAL_PAGE
iframeUrl
string

The URL of the iframe where the media was embedded and played.

mediaUrl
string

The URL where the media content is hosted.

pageId
integer<int64>

The unique identifier for the page where the media was played.

pageName
string

The name of the page where the media was played.

pageObjectCoordinates
string

Coordinates that specify the location or context of the page object.

pageUrl
string

The URL of the page where the media was played.

Last modified on September 9, 2026