Skip to main content

List Support Webhooks

GET 
/api/support/webhooks

Returns the outbound webhooks registered for the current tenant, paginated, newest first by default. Any member of the account can list them; the signing secret is never included.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Query parameters

  • filter[search] (string, optional) — case-insensitive substring match on the URL
  • filter[url] (string, optional) — substring match on the URL
  • filter[is_active] (boolean, optional) — true / false (also accepts 1 / 0)
  • filter[event] (string, optional) — one event name or a comma-separated list; matches webhooks subscribed to any of them. Allowed: ticket.created, ticket.updated, ticket.replied, ticket.resolved
  • filter[failure_count] (string, optional) — an exact number (3) or an inclusive range min,max where either end may be blank (5, = 5 or more; ,0 = none)
  • filter[last_delivered_at] (string, optional) — a single day YYYY-MM-DD or an inclusive range YYYY-MM-DD,YYYY-MM-DD
  • sort (string, optional) — prefix with - for descending. Allowed sorts: id, url, is_active, last_delivered_at, failure_count, created_at. Default -id
  • page (integer, optional) — page number, default 1
  • per_page (integer, optional) — page size, default 10, maximum 100

Webhook fields

  • id (integer)
  • tenant_id (string) — the owning tenant
  • url (string) — the HTTPS endpoint deliveries are POSTed to
  • events[] (array of strings) — subscribed events, each one of: ticket.created, ticket.updated, ticket.replied, ticket.resolved
  • is_active (boolean) — whether deliveries are queued for it; switched to false automatically after 20 consecutive failed deliveries
  • secret (string) — present only in the response to Create Support Webhook, never on a list, read or update. Store it when you create the webhook; it cannot be retrieved later (delete and re-create to rotate it)
  • created_by_user_id (integer, nullable) — who registered it
  • last_delivered_at (ISO-8601, nullable) — when a delivery last succeeded
  • failure_count (integer) — consecutive failed deliveries since the last success
  • created_at, updated_at (ISO-8601)

The response is a standard paginator: data[] plus current_page, last_page, per_page, total, from, to, first_page_url, last_page_url, next_page_url, prev_page_url, path, links.

Authentication: Bearer token with the support:read scope, or an authenticated session. Customer endpoints run in tenant context — send the X-Tenant-Id header or call from a tenant subdomain.

Request​

Responses​

OK

Response Headers
    Content-Type