Pause or resume a webhook
Set paused true to pause or false to resume. Paused endpoints collect no new events. Queued deliveries wait until resume; manual tests remain available. A request already accepted by the relay may finish. This does not clear an automatic disable.
Required scopes: webhooks:manage
In: header
Path Parameters
Webhook id, scoped to the key's user.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.
^[\x21-\x7E]{1,255}$1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause" \ -H "Content-Type: application/json" \ -d '{ "paused": true }'{ "data": { "pausedAt": "2026-10-01T12:00:00.000Z", "failureStreak": 0, "id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "url": "https://hooks.example.com/workroad", "events": [ "job.succeeded", "job.failed" ], "createdAt": "2026-01-15T09:30:00.000Z", "status": "active", "failingSince": null, "disabledAt": null, "lastDeliveryAt": "2026-02-01T12:00:00.000Z", "lastStatus": 200 }}