smartchat

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

Permissionwebhooks:read (all permissions)
RiskRead
Idempotency-KeyNot needed (how it works)
Safe to repeatSafe: the call only reads.
Rate limit classread (120 requests per minute per key)
ConfirmationNone
MCP toolNot available in MCP
Since version2026-10-25

#What it does

  • Only reads data. It changes nothing and sends nothing.

#Request

Query parameters

NameTypeRequiredDescription
limitintegernoItems per page (1 to 100, default 20). 1 to 100; default 20
cursorstringnonext_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters
statusstringnoOnly endpoints with this status. one of: active, degraded, paused, disabled

#Lists, filters and sorting

  • Items per page: limit from 1 to 100, default 20 (MCP: default 20, maximum 50).
  • Next page: send next_cursor of the answer as cursor. The cursor only works with the same filters. See Pagination.
  • Filters: status.
  • Sorting: newest first (created_at descending, then id descending); 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-*.

NameTypeDescription
objectstringAlways "list". always list
dataarray of objectThe items of this page. up to 100 items
data[].objectstringAlways "webhook_endpoint". always webhook_endpoint
data[].idstringWebhook endpoint ID.
data[].urlstringHTTPS address that receives the events. up to 2000 characters
data[].descriptionstringYour own note about this endpoint. up to 200 characters
data[].enabled_eventsarray of stringEvent types this endpoint receives, or ["*"] for all available events. up to 30 items
data[].statusstringactive and degraded receive events. paused and disabled do not; call enable_webhook_endpoint. one of: active, degraded, paused, disabled
data[].disabled_reasonstring or nullWhy the endpoint was paused or disabled. Null while it is working. up to 60 characters
data[].secret_hintstringLast 4 characters of the signing secret, for example whsec_...abcd. up to 20 characters
data[].consecutive_failuresintegerFailed delivery attempts in a row since the last success. 0 to 1000000
data[].last_success_atstring or nullTime of the last successful delivery. up to 40 characters; format date-time
data[].last_failure_atstring or nullTime of the last failed delivery attempt. up to 40 characters; format date-time
data[].secret_previous_expires_atstring or nullWhile a secret rotation is running: when the old secret stops signing. Otherwise null. up to 40 characters; format date-time
data[].created_atstringWhen the endpoint was created. up to 40 characters; format date-time
data[].updated_atstringWhen the endpoint was last changed. up to 40 characters; format date-time
has_morebooleanTrue if another page exists.
next_cursorstring or nullPass this as 'cursor' to get the next page; null on the last page. up to 300 characters
urlstringThe path of this list. up to 200 characters
total_countintegerApproximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000

#Errors

CodeStatusWhen
invalid_cursor400The cursor is expired, forged or belongs to other filters.
api_key_expired401This API key has expired.
api_key_invalid401This API key is not valid.
api_key_revoked401This API key was revoked.
authentication_required401No API key was sent. Send 'Authorization: Bearer <key>'.
insufficient_scope403This key lacks a required permission.
ip_not_allowed403This IP address is not allowed for this key.
validation_failed422A field is not valid.
rate_limited429Too many requests. Wait and try again.
internal_error500Something went wrong on our side.

All errors use one format.