Webhooks
List Webhook Endpoints
The workspace's webhook endpoints, newest first, and every event type they can subscribe to. Admins and owners (or a key with `admin`).
API key access
Needs the
admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/webhook-endpointsAuthorizationBearer <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
Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/webhook-endpoints" \ -H "X-Workspace-Id: string"{
"items": [
{
"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"
}
],
"event_types": [
{
"type": "call.completed",
"description": "string"
}
]
}Empty