List webhook endpoints
Lists the outgoing webhook endpoints of the account, newest first. Does not show signing secrets, only the last 4 characters. Use get_webhook_endpoint for one endpoint or list_webhook_deliveries for its log.
GET /v1/webhook-endpoints
| Permission | webhooks:read (all permissions) |
| Risk | Read |
| Idempotency-Key | Not needed (how it works) |
| Safe to repeat | Safe: the call only reads. |
| Rate limit class | read (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | Not available in MCP |
| Since version | 2026-10-25 |
#What it does
- Only reads data. It changes nothing and sends nothing.
#Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Items per page (1 to 100, default 20). 1 to 100; default 20 |
cursor | string | no | next_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters |
status | string | no | Only endpoints with this status. one of: active, degraded, paused, disabled |
#Lists, filters and sorting
- Items per page:
limitfrom 1 to 100, default 20 (MCP: default 20, maximum 50). - Next page: send
next_cursorof the answer ascursor. The cursor only works with the same filters. See Pagination. - Filters:
status. - Sorting: newest first (
created_atdescending, theniddescending); no other order.
#Examples
curl "https://api.smartchat.marketing/v1/webhook-endpoints?limit=20" \
-H "Authorization: Bearer $SMARTCHAT_API_KEY"import os
import requests
response = requests.get(
"https://api.smartchat.marketing/v1/webhook-endpoints",
headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
params={
"limit": "20",
},
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.smartchat.marketing/v1/webhook-endpoints?limit=20", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
},
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());Response (200):
{
"object": "list",
"data": [
{
"object": "webhook_endpoint",
"id": "whe_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
"url": "https://example.com/hooks/smartchat",
"description": "Order system",
"enabled_events": [
"contact.created",
"message.received"
],
"status": "active",
"disabled_reason": null,
"secret_hint": "whsec_...x9Qa",
"consecutive_failures": 0,
"last_success_at": "2026-10-25T09:45:00Z",
"last_failure_at": null,
"secret_previous_expires_at": null,
"created_at": "2026-10-25T09:41:07Z",
"updated_at": "2026-10-25T09:45:00Z"
}
],
"has_more": false,
"next_cursor": null,
"url": "/v1/webhook-endpoints"
}#Response
Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "list". always list |
data | array of object | The items of this page. up to 100 items |
data[].object | string | Always "webhook_endpoint". always webhook_endpoint |
data[].id | string | Webhook endpoint ID. |
data[].url | string | HTTPS address that receives the events. up to 2000 characters |
data[].description | string | Your own note about this endpoint. up to 200 characters |
data[].enabled_events | array of string | Event types this endpoint receives, or ["*"] for all available events. up to 30 items |
data[].status | string | active and degraded receive events. paused and disabled do not; call enable_webhook_endpoint. one of: active, degraded, paused, disabled |
data[].disabled_reason | string or null | Why the endpoint was paused or disabled. Null while it is working. up to 60 characters |
data[].secret_hint | string | Last 4 characters of the signing secret, for example whsec_...abcd. up to 20 characters |
data[].consecutive_failures | integer | Failed delivery attempts in a row since the last success. 0 to 1000000 |
data[].last_success_at | string or null | Time of the last successful delivery. up to 40 characters; format date-time |
data[].last_failure_at | string or null | Time of the last failed delivery attempt. up to 40 characters; format date-time |
data[].secret_previous_expires_at | string or null | While a secret rotation is running: when the old secret stops signing. Otherwise null. up to 40 characters; format date-time |
data[].created_at | string | When the endpoint was created. up to 40 characters; format date-time |
data[].updated_at | string | When the endpoint was last changed. up to 40 characters; format date-time |
has_more | boolean | True if another page exists. |
next_cursor | string or null | Pass this as 'cursor' to get the next page; null on the last page. up to 300 characters |
url | string | The path of this list. up to 200 characters |
total_count | integer | Approximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000 |
#Errors
| Code | Status | When |
|---|---|---|
invalid_cursor | 400 | The cursor is expired, forged or belongs to other filters. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
All errors use one format.