Pause or resume the queue

Stop sends for an active webhook and resume deliveries still within their deadlines.

PATCHhttps://api.raims.com/v1/webhooks/{webhook_id}/pause

Use is_paused: true to pause and is_paused: false to resume an active webhook's queue. The pause preserves pending deliveries and new events, but keeps their original deadlines. Already authorized requests may finish.

See Pause and resume the queue for expiration during a pause and the behavior when resuming.

Path Params

webhook_idstringrequired

Identifier of the webhook whose deliveries will be paused or resumed.

Up to 26 characters

Body Params

is_pausedbooleanrequired

Send true to pause deliveries or false to resume them. Repeating the same value preserves the state and pause date.

true

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request PATCH \
  --url https://api.raims.com/v1/webhooks/%7Bwebhook_id%7D/pause \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Pause or resume the queue

Path Params

Body Params

Responses

200OK

400Bad Request

404Not Found

409Conflict