pause_webhook_endpoint

Stop deliveries to an endpoint without removing it. Events raised while paused are not queued for it.

Purpose

The dashboard's on/off switch for an endpoint. A paused endpoint keeps its secret, its event subscriptions and its delivery log; what stops is new deliveries. Use it during a consumer outage or a migration, then resume_webhook_endpoint.

Paused events are not replayed

Events raised while the endpoint is paused are not queued for it, so they are gone for that endpoint when it resumes. If the consumer must see everything, leave the endpoint on and let the retry ladder and retry_dead_webhook_deliveries carry it through the outage instead.

Only the creator who registered the endpoint, or the team owner, may pause it; a fellow team member is refused with FORBIDDEN. Idempotent: an already-paused endpoint is a no-op.

Required ability

webhook-endpoint:update

Input schema

{
  "type": "object",
  "required": ["endpoint_id"],
  "properties": {
    "endpoint_id": {
      "type": "string",
      "description": "UUID of the webhook endpoint to pause."
    }
  }
}

Output shape

{
  "data": {
    "id": "c62a08f4-1b7d-4e35-9860-a37f5d21e0b9",
    "name": "CRM sync",
    "url": "https://hooks.example.com/subscriby",
    "project_id": null,
    "events": ["subscription.created", "subscription.cancelled"],
    "is_active": false,
    "disabled_at": "2026-09-06T09:20:00+00:00",
    "allowed_ips": [],
    "failure_count": 2,
    "consecutive_failures": 0,
    "last_success_at": "2026-09-05T18:00:00+00:00",
    "last_failure_at": "2026-08-30T07:12:00+00:00",
    "created_at": "2026-05-18T10:05:00+00:00"
  }
}

Example prompts

"Pause webhook endpoint c62a08f4-1b7d-4e35-9860-a37f5d21e0b9 while we migrate the CRM."

"Stop deliveries to the staging endpoint for now, don't delete it."

"Switch the finance webhook off until the handler is fixed."

Failure modes

FORBIDDEN — the token belongs to a team member who did not register the endpoint and is not the team owner.
VALIDATION_FAILED — the pause was refused for the endpoint's current state.
RESOURCE_NOT_FOUND — unknown endpoint_id, or an endpoint of another team.
AUTHENTICATION_REQUIRED — no authenticated user on the request.
TOKEN_MISSING_ABILITY — token lacks webhook-endpoint:update.

resume_webhook_endpoint — the reverse.
delete_webhook_endpoint — when it is not coming back.
Webhook endpoints API — the REST equivalent.