Skip to main content

Raise Alert

POST 
/api/support/agent/alerts

The AI agent's autopilot runner raises an alert for the humans: a problem with the runner itself (runner, e.g. its health check failed and it stopped picking up tickets) or an error on a ticket (ai_error). One alert is written for every active agent who can work tickets (admins and agents, never viewers), announced in real time and pushed to their installed apps.

Required scope: support:write

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

Only the AI agent's token may call this — anyone else gets 403. The same kind, title and ticket_id raised again within 30 minutes is dropped (created is 0), so a runner retrying every few minutes does not flood the desk.

Request body

  • kind (string, required) — runner or ai_error
  • title (string, required, max 160)
  • body (string, optional, nullable, max 2000)
  • ticket_id (integer, optional, nullable) — must be an existing ticket
  • url (string, optional, nullable, max 500) — a path inside the agent console, starting with /. Defaults to the ticket (/?ticket=<id&gt;), or / when there is no ticket.

Response (201)

  • created (integer) — how many agents were alerted; 0 when it was a repeat

Request​

Responses​

Created

Response Headers
    Content-Type