Documentação

Eventos de correspondência

A CartaFlow faz um POST para a URL do seu webhook a cada mudança de status de uma correspondência, e com `letter.updated` quando ela é alterada no painel antes da produção, com o evento no corpo.

Cabeçalhos

webhook-id*string

Id do evento. Igual em todas as tentativas de entrega do mesmo evento: use para ignorar repetições.

webhook-timestamp*string

Momento do envio em segundos Unix. Recuse entregas com mais de 5 minutos de diferença do seu relógio.

webhook-signature*string

Assinatura HMAC-SHA256 no padrão Standard Webhooks. Confira antes de confiar no conteúdo; veja o guia Webhooks.

Corpo da requisição

application/json
  1. body

Um acontecimento na sua conta, como uma correspondência postada. A CartaFlow envia cada evento para os seus webhooks e guarda por 30 dias.

id*string

Identificador único do evento. É o mesmo valor do cabeçalho webhook-id: use para ignorar entregas repetidas. Sempre começa com evt_.

Formato^evt_[A-Za-z0-9]+$
object*string

Tipo do objeto. Sempre event.

type*string

O tipo do evento.

Valores possíveis

  • letter.scheduled: Uma correspondência foi agendada com send_date. Ainda não foi cobrada.
  • letter.received: Uma correspondência foi cobrada e entrou na fila de produção: logo depois de criada ou, se foi agendada, na data do envio. Vale para correspondências criadas pela API e pelo painel.
  • letter.in_production: A correspondência entrou em um lote de impressão e não pode mais ser cancelada.
  • letter.printed: A correspondência foi impressa e envelopada.
  • letter.posted: A correspondência foi entregue aos Correios. É o último evento de uma correspondência enviada.
  • letter.canceled: A correspondência foi cancelada. Veja cancellation_reason: requested quando você cancelou, insufficient_balance quando uma correspondência agendada não pôde ser cobrada na data.
  • letter.failed: A correspondência falhou na produção e não será postada. O valor voltou para o saldo automaticamente. Veja failure_reason.
  • letter.updated: A correspondência foi alterada no painel antes da produção, sem mudar de status: data de envio, endereço, arquivo, variáveis, impressão, serviços dos Correios ou referência. data traz a correspondência como ficou. Se a mudança alterou o preço de uma correspondência agendada, price traz o novo valor.
Valores"letter.scheduled""letter.received""letter.in_production""letter.printed""letter.posted""letter.canceled""letter.failed""letter.updated"
data*|

O objeto inteiro, como estava logo depois do acontecimento: uma correspondência nos eventos letter.* e uma verificação nos eventos verification.*.

created_at*string

Quando o evento aconteceu.

Formatodate-time

Corpo da resposta

Responda com qualquer status 2xx em até 15 segundos para confirmar o recebimento. Faça o processamento demorado depois de responder.

Exemplos de requisição

POST/letter-events