Webhooks
PATCH
/webhooks/{id}

Changes the url, the subscribed events, or whether the endpoint is enabled. Provide at least one. Sending events replaces the whole list rather than adding to it.

Re-enabling a disabled endpoint clears its failure count and its disabledReason, giving it a clean slate. The signing secret never changes and is never returned.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created under Settings > API & Webhooks. Keys start with sf_live_.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/webhooks/string" \  -H "Content-Type: application/json" \  -d '{    "events": [      "video.render_completed",      "video.publish_failed"    ],    "enabled": true  }'
{  "data": {    "id": "string",    "url": "http://example.com",    "events": [      "video.created"    ],    "enabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "lastDeliveryAt": "2019-08-24T14:15:22Z",    "failureCount": 0,    "disabledReason": "string"  }}