Skip to main content

List Agent Webhooks

GET 
/api/support/agent/webhooks

Lists every outbound support webhook endpoint across every tenant, plus the global ones (tenant_id null) that receive every tenant's ticket events. Read-only: endpoints are registered and edited by the tenant through the customer webhook endpoints. The signing secret is never returned here.

Required scope: support:read

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

An endpoint is switched off automatically (is_active false) after 20 consecutive failed deliveries; failure_count is the current streak and resets to 0 on the next successful delivery or when the tenant re-enables the endpoint.

Query parameters — every filter is optional

  • filter[search] (string) — endpoint URL or tenant id contains the text
  • filter[tenant_id] (string) — one tenant id or a comma-separated list
  • filter[url] (string) — endpoint URL contains the text
  • filter[is_active] (boolean) — true / false
  • filter[event] (string) — subscribed to any of the given events; one value or a comma-separated list of: ticket.created, ticket.updated, ticket.replied, ticket.resolved
  • filter[failure_count] (string) — a single number, or an inclusive min,max range (either end may be blank)
  • filter[last_delivered_at] (string) — a single day YYYY-MM-DD or an inclusive from,to range
  • sort (string) — prefix with - for descending. Allowed sorts: id, tenant_id, url, is_active, last_delivered_at, failure_count, created_at. Default: -id.
  • page, per_page (integer) — standard pagination; per_page default 10, maximum 100

An unknown filter[...] key or sort field is rejected with 400.

Response fields (each entry in data[]; standard pagination envelope)

  • id (integer)
  • tenant_id (string, nullable) — null for a global endpoint
  • url (string) — the HTTPS endpoint
  • events[] (array of strings) — the subscribed events
  • is_active (boolean)
  • created_by_user_id (integer, nullable)
  • last_delivered_at (ISO-8601, nullable) — the last successful delivery
  • failure_count (integer) — consecutive failed deliveries
  • created_at, updated_at (ISO-8601)

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role (any role, including viewer). No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type