API reference / Webhooks

Webhooks

HTTP event notification registrations.

GET /api/v1/webhooks/

List webhooks.

Response

Response 200 (application/json)
{
  "webhooks": [
    {
      "id": "string",
      "url": "string",
      "events": [
        "string"
      ],
      "createdAt": "string",
      "secret": "string"
    }
  ]
}

POST /api/v1/webhooks/

Register a webhook.

Request

Request body (application/json)
{
  "url": "https://example.com/video.mp4",
  "events": [
    "asset.ready"
  ],
  "secret": "string"
}

Response

Response 201 (application/json)
{
  "id": "string",
  "url": "string",
  "events": [
    "string"
  ],
  "createdAt": "string",
  "secret": "string"
}

DELETE /api/v1/webhooks/{id}

Delete a webhook.

Parameters

NameInTypeRequired
idpathstringrequired

Response

Response 204 (application/json)
"null"