Events

Send an event

Sends a playback event (such as play, ping, pauseStart, bufferStart, bitrateChange, chapterStart, or an ad event) to an active session. The request body has the same structure as a sessions request. A successful call returns 204 No Content; the endpoint does not return a body.

post/sessions/{sid}/events

Request

  • Base URL: https://example.hb-api.omtrdc.net/api/v1
  • URL: https://example.hb-api.omtrdc.net/api/v1/sessions/{sid}/events
  • Auth: none declared. Required headers: Content-Type

Path parameters

sidstring required

The session ID returned in the Location header of the sessions request.

Headers

Content-Typestring required

Must be application/json.

Request body

eventType'sessionStart' | 'sessionComplete' | 'sessionEnd' | 'adBreakStart' | 'adBreakComplete' | 'adStart' | 'adComplete' | 'adSkip' | 'chapterStart' | 'chapterComplete' | 'chapterSkip' | 'play' | 'ping' | 'bufferStart' | 'pauseStart' | 'bitrateChange' | 'error' | 'stateStart' | 'stateEnd' required

The media tracking event type sent on the wire.

customMetadataCustomMetadata

Free-form string key-value pairs. Sent only with the sessionStart, adStart, and chapterStart event types. All values must be strings.

Example request

{
  "playerTime": {
    "playhead": 0,
    "ts": 1731672000000
  },
  "eventType": "sessionStart",
  "params": {
    "analytics.trackingServer": "example.data.adobedc.net",
    "analytics.reportSuite": "example-rsid",
    "analytics.enableSSL": true,
    "visitor.marketingCloudOrgId": "0123456789ABCDEF0123456789@AdobeOrg",
    "media.id": "sample-video-id",
    "media.name": "Sample video",
    "media.length": 3600,
    "media.contentType": "vod",
    "media.playerName": "sample-html5-player",
    "media.channel": "sample-channel"
  }
}

Response

No content. The event was accepted successfully.

Changes

No recorded changes to this operation across all 4 revisions of this API.