Catálogo de eventos disponíveis

Lista os eventos que podem ser assinados, agrupados por módulo.
Use os valores de events[].type no campo events do
POST /api/v2/webhooks/subscriptions.

Catálogo atual: Tickets (ticket.created, ticket.updated, ticket.closed,
ticket.phase_changed, ticket.activity), SLA (sla.updated),
Mensagens (message.created, message.status_changed) e
Clientes (customer.created, customer.updated).

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Envelope {ok, data} com módulos e eventos.

Bodyapplication/json

Exemplo

{
    "ok": true,
    "code": 200,
    "data": [
        {
            "module": "Tickets",
            "events": [
                {
                    "type": "ticket.created",
                    "description": "Ticket criado"
                },
                {
                    "type": "ticket.updated",
                    "description": "Ticket atualizado"
                },
                {
                    "type": "ticket.closed",
                    "description": "Ticket encerrado"
                },
                {
                    "type": "ticket.phase_changed",
                    "description": "Fase do ticket alterada"
                },
                {
                    "type": "ticket.activity",
                    "description": "Atividade registrada no ticket"
                }
            ]
        },
        {
            "module": "SLA",
            "events": [
                {
                    "type": "sla.updated",
                    "description": "SLA vencido"
                }
            ]
        },
        {
            "module": "Mensagens",
            "events": [
                {
                    "type": "message.created",
                    "description": "Nova mensagem"
                },
                {
                    "type": "message.status_changed",
                    "description": "Status da mensagem alterado"
                }
            ]
        },
        {
            "module": "Clientes",
            "events": [
                {
                    "type": "customer.created",
                    "description": "Cliente criado"
                },
                {
                    "type": "customer.updated",
                    "description": "Cliente atualizado"
                }
            ]
        }
    ]
}

Catálogo de eventos disponíveis

Requisição

Códigos de solicitação

Respostas