Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Webhooks

Update Webhook Endpoint

Change the URL, event types, description or enabled flag. Enabling a disabled endpoint resets its failure count.

API key access

Needs the admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
PATCH/api/v1/webhook-endpoints/{endpoint_id}

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Path Parameters

endpoint_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

url?string | null
Length1 <= length <= 2048
event_types?array<string> | null
Items1 <= items <= 50
description?string | null
Lengthlength <= 200
enabled?boolean | null

true re-enables a disabled endpoint and resets its failure count.

Response Body

curl -X PATCH "http://localhost:8000/api/v1/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "url": "https://hooks.example.com/reachout",
  "description": "string",
  "event_types": [
    "string"
  ],
  "secret_prefix": "whsec_Ab3d",
  "enabled": true,
  "disabled_reason": "string",
  "disabled_at": "2019-08-24T14:15:22Z",
  "consecutive_failures": 0,
  "last_success_at": "2019-08-24T14:15:22Z",
  "last_failure_at": "2019-08-24T14:15:22Z",
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Test Webhook Endpoint

Send a signed `webhook.test` event now (one attempt, no retries; the endpoint's failure count is not touched) and return the delivery with the receiver's answer.

Create Invite

Create a single-use invite link for a role (admin+; `owner` only by owners). The link (`url`, with its `token`) is in this response only. It expires after `expires_in_days` (default 7). 409 if `email_hint` already belongs to a member or the workspace has `INVITE_MAX_PENDING` pending invites. Signed-in users only: an API key gets 403.