Overview

The Webhooks API is used to create, retrieve, update, delete webhooks object from pipeline.

Webhook Object

id · string

Unique identifier for the webhook.

name · string

Name of the webhook.

createdAt · number

Timestamp (in milliseconds) at which the webhook object was created.

events · array

List of events that the webhook subscribes to. Possible events include stream.started, stream.detection, recording.ready, etc.

url · string

URL of the webhook endpoint.

sharedSecret · string

Shared secret used to sign the webhook payload.

streamId · string

StreamId of the stream to which the webhook is applied.

status · object

Status of the webhook, including last failure and last triggered timestamp.

Response

{
  "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "name": "My webhook",
  "createdAt": 1587667174725,
  "events": [
    "stream.started",
    "recording.ready"
  ],
  "url": "https://webhook.example.com",
  "sharedSecret": "mySharedSecret",
  "streamId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "status": {
    "lastFailure": {
      "timestamp": 1587667174725,
      "error": "Error message",
      "response": "Response body",
      "statusCode": 500
    },
    "lastTriggeredAt": 1587667174725
  }
}