POST
/
webhook

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
url
string
required
projectId
string

The ID of the project

events
enum<string>[]
Available options:
stream.started,
stream.detection,
stream.idle,
recording.ready,
recording.started,
recording.waiting,
multistream.connected,
multistream.error,
multistream.disconnected,
playback.user.new,
playback.accessControl,
asset.created,
asset.updated,
asset.failed,
asset.ready,
asset.deleted,
task.spawned,
task.updated,
task.completed,
task.failed
sharedSecret
string

shared secret used to sign the webhook payload

streamId
string

streamId of the stream on which the webhook is applied

Response

200 - application/json
name
string
required
url
string
required
id
string
kind
string
deprecated
userId
string
deprecated
projectId
string

The ID of the project

createdAt
number

Timestamp (in milliseconds) at which stream object was created

events
enum<string>[]
Available options:
stream.started,
stream.detection,
stream.idle,
recording.ready,
recording.started,
recording.waiting,
multistream.connected,
multistream.error,
multistream.disconnected,
playback.user.new,
playback.accessControl,
asset.created,
asset.updated,
asset.failed,
asset.ready,
asset.deleted,
task.spawned,
task.updated,
task.completed,
task.failed
streamId
string

streamId of the stream on which the webhook is applied

status
object

status of webhook

Was this page helpful?

OverviewRetrieve a webhook