Webhooks

Get a webhook

Fetch a single webhook by id. An unknown id and an id belonging to another tenant both return the same not-found error — existence is never leaked. The signing secret is not included (shown only at creation).

GET
/webhooks/{webhook_id}

Fetch a single webhook by id. An unknown id and an id belonging to another tenant both return the same not-found error — existence is never leaked. The signing secret is not included (shown only at creation).

Authorization

x-api-key<token>

The per-tenant API key. Sent as the x-api-key request header. The key is tenant-scoped.

In: header

Path Parameters

webhook_id*string

The webhook's opaque id (e.g. wh_…).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhooks/string"
{  "webhook_id": "string",  "url": "http://example.com",  "event_types": [    "message.received"  ],  "inbox_ids": [    "string"  ],  "enabled": true,  "client_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}

Delete a webhook DELETE

Delete a webhook by id; deliveries to it stop immediately and any in-flight retries are abandoned. An unknown, already-deleted, or cross-tenant id returns not-found.

List webhooks GET

List the tenant's webhooks, newest-first by default, with cursor pagination. The signing secret is never included in a listing — it is shown only once at creation.