---
title: "Pause a webhook endpoint"
method: POST
path: "/v1/webhook-endpoints/{endpoint}/pause"
tags: ["Webhook Endpoints"]
---

# Pause a webhook endpoint

`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

```bash
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](https://docs.subscriby.net/api/v1/reference/webhook-deliveries) to replay rows that dead-lettered before the pause. Answers `200` with the endpoint; idempotent, pausing a paused endpoint changes nothing.

## Path parameters

- `endpoint` string, uuid, required

## Headers

- `Idempotency-Key` string, uuid, required

## Response `200`

The endpoint, paused.

- object
  - `data` WebhookEndpointResource, required: A webhook endpoint: a target Subscriby posts events to, with its subscriptions and delivery health. The signing secret never appears here.
    - `id` string, required: The endpoint's id.
    - `name` string, required: The label the endpoint was registered with, 3 to 100 characters.
    - `url` string, required: The `https://` URL events are posted to.
    - `project_id` string, nullable, required: The project the endpoint is confined to; null for a team-wide endpoint that receives every project's events.
    - `events` string[], required: The event names the endpoint is subscribed to.
    - `is_active` boolean, required: Whether deliveries flow. False while paused by the creator or switched off by the worker after too many consecutive failures.
    - `disabled_at` string, nullable, required: When the endpoint was paused or auto-disabled, ISO 8601; null while active.
    - `allowed_ips` unknown[], nullable, required: IPv4/IPv6 addresses or CIDR ranges the target must resolve to; a delivery whose host resolves elsewhere is dead-lettered without being posted. Null when unrestricted.
      - unknown
    - `failure_count` integer, required: How many deliveries have failed over the endpoint's lifetime.
    - `consecutive_failures` integer, required: The current failure streak; the worker disables the endpoint when it reaches the limit, and resuming resets it.
    - `last_success_at` string, nullable, required: When a delivery last got a 2xx, ISO 8601; null until one has.
    - `last_failure_at` string, nullable, required: When a delivery last failed, ISO 8601; null until one has.
    - `created_at` string, nullable, required: When the endpoint was registered, ISO 8601.
    - `updated_at` string, nullable, required: When the endpoint last changed, ISO 8601.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description. On this endpoint: `FORBIDDEN`: when the caller neither registered the endpoint nor owns the team.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)