API referenceWebhooks
Get a webhook
Fetch one webhook by id. Requires the manage capability, and the webhook must belong to the caller's organization.
The signing secret is never returned. Errors: 404 not_found if no webhook with that id is owned by the caller's organization; 403 forbidden if the caller lacks the manage capability.
AuthorizationBearer <token>
Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.
In: header
Path Parameters
id*string
The webhook id. Must reference a webhook owned by the caller's organization, otherwise the request fails with a 404 "not_found".
Example
"01HHX5WEBHOOK..."Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/webhooks/01HHX5WEBHOOK..."{ "active": true, "createdAt": 1719662400000, "customHeaders": { "X-Tenant": "acme" }, "events": [ "message", "poll.vote" ], "id": "wh_01J9...", "organizationId": "org_01J9ABC...", "retryPolicy": { "attempts": 15, "delaySeconds": 2, "policy": "exponential" }, "sessionId": "01J9ZX8K2QHV0M3T6R7P4N5W8C", "updatedAt": 1719662400000, "url": "https://example.com/webhooks/wa"}{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}