Documentation
Version
Platform Dashboard GuideREST API ReferenceMCP Server for AI AgentsBuilding ConnectorsWebhooks & EventsAutomations & Integrations
DESTRUCTIVE

pause_webhook_endpoint

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

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.

Requires ability

webhook-endpoint:update

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Runs the same action as

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

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

DestructiveIdempotent

A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time.

Arguments

endpoint_id*string

UUID of the webhook endpoint to pause.

What it returns

{  "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"  }}

How it fails

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.

Related

resume_webhook_endpointthe reverse.delete_webhook_endpointwhen it is not coming back.Webhook endpoints APIthe REST equivalent.

How is this guide?

Last updated on

list_webhook_endpoints

List outbound webhook endpoints registered for the caller's team. Optional project_id filter, optional active_only filter. Secrets are never returned.

resume_webhook_endpoint

Start deliveries to a paused endpoint again and clear its failure streak. Events raised while paused are not replayed.