Webhook
Update a webhook
PUT
/
webhook
/
{id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
id
string
requiredBody
application/json
name
string
requiredprojectId
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
url
string
requiredsharedSecret
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
id
string
name
string
requiredkind
string
deprecateduserId
string
deprecatedprojectId
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
url
string
requiredstreamId
string
streamId of the stream on which the webhook is applied
status
object
status of webhook
Was this page helpful?