Skip to content
Webhooks

Update a webhook endpoint

PATCH/api/v1alpha1/webhooks/{webhook_id}

Changes a webhook endpoint: its URL, which events it receives, its description, or whether it is enabled.

  • Access: an alpha-enabled API key with the MANAGE_WEBHOOKS permission.
  • URL rules: a new URL passes the same checks as at creation - HTTPS, no credentials, and a public address only.
  • Retries: Idempotency-Key applies to POST endpoints only, so repeating a PATCH is not deduplicated. Send it again only when you know the state you want.

After changing the events or the enabled flag, check the delivery history to confirm the endpoint now behaves as you intended.

AuthorizationBearer <token>

In: header

Path Parameters

webhook_id*string

Identifier of a registered webhook endpoint.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/api/v1alpha1/webhooks/wh_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "description": "Warehouse staging review pipeline",    "enabled": true,    "events": [      "video.failed",      "run.completed"    ],    "url": "https://hooks.example.com/deepframe-v2"  }'
{  "created_at": "2026-08-08T10:00:00.000Z",  "description": "Warehouse review pipeline",  "enabled": true,  "events": [    "video.indexed",    "run.completed"  ],  "id": "wh_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "updated_at": "2026-08-08T10:09:00.000Z",  "url": "https://hooks.example.com/deepframe"}