Skip to main content

Update Support Webhook

PUT 
/api/support/webhooks/:webhook

Changes a webhook's URL, subscribed events or active flag. This is a partial update: any field left out keeps its current value. Switching a webhook from inactive to active resets its failure_count to 0 and starts a fresh failure streak. The secret cannot be changed or re-read here. Only a tenant admin can update webhooks; a webhook belonging to another tenant is a 404.

Required scope: support:write

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

Request body (all optional)

  • url (string, max 2048) — an absolute URL starting with https://; when it differs from the current URL it goes through the same public-host check as on create
  • events[] (array of strings, at least 1 when sent) — each one of: ticket.created, ticket.updated, ticket.replied, ticket.resolved
  • is_active (boolean)

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)

Authentication: Bearer token with the support:write 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