Skip to content
X-Buddy
Tiếng Việt

API reference

Pause or resume a webhook endpoint

webhook_set_active — active=false pauses (events keep being stored and queued); active=true resumes and clears an automatic pause.

Markdown version

webhook_set_active · Changes an X-Buddy setting

active=false pauses (events keep being stored and queued); active=true resumes and clears an automatic pause.
REST POST /api/public/v1/webhooks/{endpoint_id}/active
MCP tool webhook_set_active
Permission needed integrations.manage — Owner, Manager
Scope group webhooks:manage
Group Events and webhooks
Shown up front in profiles Infrastructure

Input

Field Type Required Description
endpoint_id string (uuid) Yes Endpoint id.
active boolean Yes
expected_revision integer (1–∞) Yes The revision you read (optimistic locking); a newer revision fails with revision_conflict.

Result

Returns the operation's result in the { data, meta } envelope.

Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/webhooks/00000000-0000-4000-8000-000000000001/active" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H "Content-Type: application/json" \
  -d '{"active":false,"expected_revision":1}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "webhook_set_active",
    "arguments": {
      "endpoint_id": "00000000-0000-4000-8000-000000000001",
      "active": false,
      "expected_revision": 1,
      "idempotency_key": "6f1c2a90-example-key"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
read_only 403 No
idempotency_key_required 428 No
idempotency_conflict 409 No
idempotency_processing 409 Yes
conflict 409 No
precondition_failed 422 No
revision_required 428 No
revision_conflict 412 No
not_found 404 No

Back to all operations