Webhook Endpoints

Pause a webhook endpoint

curl -X POST https://api.subscriby.net/v1/webhook-endpoints/$ENDPOINT_ID/pause \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

The dashboard's on/off switch, off. A paused endpoint keeps its secret, its event subscriptions and its delivery log, but events raised while it is paused are not queued for it and are not replayed on resume; use the deliveries API to replay rows that dead-lettered before the pause. Answers 200 with the endpoint; idempotent, pausing a paused endpoint changes nothing.

post/v1/webhook-endpoints/{endpoint}/pause

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/webhook-endpoints/{endpoint}/pause
  • Auth: HTTP bearer

Path parameters

endpointstring uuid required

The endpoint, resolved by the route binder.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Response

The endpoint, paused.

Example response

{
  "data": {
    "id": "c62a08f4-1b7d-4e35-9860-a37f5d21e0b9",
    "name": "Zapier trigger",
    "url": "https://hooks.zapier.com/hooks/catch/...",
    "events": [
      "subscription.created"
    ],
    "is_active": true,
    "created_at": "2026-05-18T10:05:00Z",
    "updated_at": "2026-05-18T10:05:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.