📨 [Contrato] Evento entregue na sua URL

Este NÃO é um endpoint da Digitalk — é o contrato do POST que a
plataforma faz na URL que você cadastrou na assinatura.

Envelope

Todo evento chega como JSON {id, event_id, event_type, timestamp, data}.
id = UUID da entrega (idempotência: re-tentativas REPETEM event_id,
mas trocam id). data segue a convenção

{description, snapshot,
changes?, context}

— snapshot é o objeto no momento do evento e
context traz metadados (ex.: operator_id). No ticket.closed, data
ganha também crm com dados do cliente vinculado.

Validação da assinatura (HMAC-SHA256) — FAÇA ISSO

A assinatura cobre timestamp.body (proteção contra replay):

Rejeite também timestamps muito antigos (ex.: > 5 min) pra bloquear replay.

O que a Digitalk espera de você

Resposta 2xx em até 10 segundos (timeout). Dica: responda 202 na hora
e processe assíncrono.

Redirects NÃO são seguidos.

Sua resposta é registrada no log de entregas (truncada em 4 KB).

Retry

Falhou (não-2xx, timeout, erro de rede)? Até 5 tentativas com backoff:
1 min → 5 min → 15 min → 1 h → 6 h. Depois disso a entrega fica failed
definitivo — reprocessável via POST /api/v2/webhooks/deliveries/{id}/retry.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

ticket.createdticket.updated (com changes)ticket.closed (com dados CRM)

{
    "id": "9c8b7a6f-5e4d-3c2b-1a0f-9e8d7c6b5a4f",
    "event_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "event_type": "ticket.created",
    "timestamp": 1718114400000,
    "data": {
        "description": "Ticket criado",
        "snapshot": {
            "id": "2d83f114-08a0-4d20-aa09-7e9d3421a0db",
            "name": "Atendimento João",
            "workflow_id": "877784d9-25ac-456c-87b7-2a3e2e97988f",
            "phase_id": "45e57312-9cff-460a-a707-ed509af000f6"
        },
        "context": {
            "operator_id": 1234
        }
    }
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Qualquer 2xx do SEU servidor marca a entrega como success. Responda rápido (até 10s) — de preferência 202 + processamento assíncrono.

Bodyapplication/json

Exemplo

{
    "received": true
}

📨 [Contrato] Evento entregue na sua URL

Envelope#

Validação da assinatura (HMAC-SHA256) — FAÇA ISSO#

O que a Digitalk espera de você#