Events endpoint

The events endpoint sends playback events to an active session in the Streaming Media Collection API (such as pings, pauses, chapters, and ad events). This page documents the request URI, request body, event types, response, and response codes.

Request

POST https://{uri}/api/v1/sessions/{sid}/events

Send an HTTP POST with a JSON request body and the Content-Type: application/json header. For the complete machine-readable definition, see the Media Collection API reference.

URI parameter

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

Request body

The request body must be JSON and has the same structure as a sessions request. The following example is a play event.

{
    "playerTime": {
        "playhead": 30,
        "ts": 1731672030000
    },
    "eventType": "play",
    "params": {}
}

Field notes:

• playerTime (required)

  • playhead: The playhead position, in seconds. The value can be a floating-point number.
  • ts: The timestamp, in milliseconds.

• eventType (required): See Event types.

• params (optional; required for some event types): See Request parameters.

• customMetadata (optional): Sent only with the sessionStart, adStart, and chapterStart event types. See Custom metadata.

• qoeData (optional): Quality-of-experience data.

Event types

The eventType member identifies the media event. The following values are sent on the wire:

Note the wire spelling: use pauseStart (not pause), and ping for the heartbeat. Resuming after a pause, buffer, or seek is reported with a play event; there are no separate pause, bufferComplete, seekStart, or seekComplete event types on the wire.

data-variant=warning

data-slots=text

Response

A successful call returns 204 No Content with no response body. Client implementations typically treat event calls as fire-and-forget and do not inspect the response beyond the status code.

HTTP/1.1 204 No Content
Date: Thu, 15 Jan 2026 19:15:24 GMT
Connection: keep-alive
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: OPTIONS,POST,PUT
Access-Control-Allow-Headers: Content-Type
Access-Control-Expose-Headers: Location

Response codes