Webhooksv4

List webhooks

GET/webhooks

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Query parameters

limitoptionalinteger

Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with cursor to paginate.

cursoroptionalstring

Opaque pagination cursor. Pass the next_cursor value from a previous response to fetch the next page; omit it on the first request.

Returns

dataoptionalWebhook[]

Array of Webhook

idoptionalstring

Webhook id (wh_...).

urloptionalstring
event_typesoptionalstring[]

The events this webhook receives. ["*"] for every webhook created since event filtering was retired; subscriptions registered before that keep their original list, which is frozen and cannot be changed.

statusoptionalstring
"active""disabled"
scopeoptionalstring

Which lines this subscription receives events for. organization covers every line; the other two are limited to the lines that owner holds.

"organization""api_key""integration"
api_keyoptionalstring | null

The owning API key when scope is api_key, otherwise null.

integration_idoptionalstring | null

The owning integration when scope is integration, otherwise null.

channel_idoptionalstring | null
channel_typeoptionalstring | null
created_atoptionalinteger
has_moreoptionalboolean
next_cursoroptionalstring | null

Response codes

200A page of webhooks
401Your API key is missing or invalid. Pass it as a bearer token.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X GET https://api.blooio.com/v4/webhooks?limit=50&cursor=string \
Response objectexample
{  "data": [    {      "id": "wh_a1b2c3d4",      "url": "https://example.com",      "event_types": [        "string"      ],      "status": "active",      "scope": "organization",      "api_key": "sk_live_a1b2c3d4",      "integration_id": "wh_a1b2c3d4",      "channel_id": "ch_a1b2c3d4",      "channel_type": "string",      "created_at": 0    }  ],  "has_more": true,  "next_cursor": "string"}