curl --request GET \
--url https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints")
.header("Authorization", "Bearer <token>")
.asString();{
"data": [
{
"id": "018f3c4e-7b2a-7c3d-8e9f-eeeeeeeeeeee",
"business_id": "018f3c4e-7b2a-7c3d-8e9f-0123456789ab",
"url": "https://hooks.example.com/1funnel/webhooks",
"description": "Production SMS delivery callbacks",
"status": "active",
"event_types": [
"sms.message.delivered.v1"
],
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}
],
"pagination": {
"limit": 50,
"has_more": false,
"next_cursor": null
}
}List webhook endpoints
Cursor-paginated endpoints for the granted business (ADR-021 WH-01, DEC-WH-P01). Uses shared pagination (default 50 / max 200) — not SmsLimit. Default maximum five active endpoints per business.
curl --request GET \
--url https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.1-funnel.org/v1/businesses/{businessId}/webhook-endpoints")
.header("Authorization", "Bearer <token>")
.asString();{
"data": [
{
"id": "018f3c4e-7b2a-7c3d-8e9f-eeeeeeeeeeee",
"business_id": "018f3c4e-7b2a-7c3d-8e9f-0123456789ab",
"url": "https://hooks.example.com/1funnel/webhooks",
"description": "Production SMS delivery callbacks",
"status": "active",
"event_types": [
"sms.message.delivered.v1"
],
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}
],
"pagination": {
"limit": 50,
"has_more": false,
"next_cursor": null
}
}Authorizations
OAuth 2.0 Client Credentials for the External Integration API (ADR-015, ADR-023).
Client authentication: HTTP Basic (client_secret_basic).
Access-token audience: 1funnel-external-api.
The tokenUrl below is the production target. Sandbox uses a different
host. OpenAPI cannot bind tokenUrl to the selected servers entry; see
x-1funnel-oauth on the root document and the authentication guide when published.
Coarse OAuth scopes (if any) are token-level vocabulary (ADR-013 IA-06). They
are not the ADR-022 resource permission catalogue. Resource permissions
are enforced after token validation via application-to-business grants
(ADR-016) and are documented per operation with x-required-permissions.
These URLs are architecture targets. They are not claimed to be deployed or generally available.
Headers
Request correlation identifier (STD-API-01 D12). Clients may supply a value
of 1–128 characters matching A-Za-z0-9._-. Missing or invalid values are
replaced by a server-generated identifier. Distinct from W3C traceparent,
resource ids, Idempotency-Key, and webhook event ids.
1 - 128^[A-Za-z0-9._-]+$"req_01HZX3K9EXAMPLE"
Path Parameters
Business resource selector in /v1/businesses/{businessId}/… (ADR-006).
UUIDv7-compatible opaque identifier. {businessId} is not authorization
proof. The resource server must independently verify an active
application-to-business grant, required permission, and ownership (ADR-016,
ADR-022).
UUID with version nibble 7 (UUIDv7). STD-API-01 prefers UUIDv7 for new
platform-generated external resource identifiers. Clients must still treat
the value as opaque. Not every path parameter is guaranteed to be v7 solely
because it is a UUID; use this schema where the contract asserts UUIDv7.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"018f3c4e-7b2a-7c3d-8e9f-0123456789ab"
Query Parameters
Maximum number of items to return (STD-API-01 D05). Default is 50 when omitted. Values greater than 200 must be rejected with 400.
1 <= x <= 20050
Opaque pagination cursor from a previous response pagination.next_cursor
(STD-API-01 D05). Clients must not parse the cursor. Changing filter or sort
parameters invalidates a previous cursor. Cursor lifetime is not set by this
foundation and must be documented per capability when applicable.
1"eyJvZmZzZXQiOiJleGFtcGxlIn0"
Endpoint lifecycle in v1 (DEC-WH-V01 deferred ownership verification;
DEC-WH-E01 soft-delete). Endpoints become active after successful creation
and destination security validation. disabled is the deactivated state
after DELETE or explicit disable. Ownership verification is a future
capability — not a v1 prerequisite.
active, disabled "active"
Response
Endpoint page
Cursor-paginated webhook endpoints.
Page of resources. Item schemas are capability-specific.
Show child attributes
Show child attributes
Cursor pagination metadata for collection responses (STD-API-01 D05).
Field names are normative: limit, has_more, next_cursor.
Show child attributes
Show child attributes
{
"limit": 50,
"has_more": false,
"next_cursor": null
}