Pular para o conteúdo principal

Webhook

Setup​

Para utilizar esta solução, é importante comunicar à nossa equipe de atendimento o seu interesse, bem como o endpoint destinado a receber as respostas geradas pela nossa aplicação. Nossas chamadas de aplicação são compatíveis com autenticação por meio de parâmetros fixos no campo 'Authorization' do cabeçalho. A chamada sempre será um POST e o endpoint invocado deverá sempre retornar um status 2xx.

Gatilhos que iniciam o fluxo​

Qualquer alteração no status do e-mail acionará a chamada para o endpoint previamente configurado com nossa equipe de atendimento.

Retornos​

Payload de retorno​

{
  "notificationID": "ID da Notificação",
  "channel": "Canal do Status",
  "description": "Descrição do Status",
  "dateSent": "Data do envio",
  "dateDelivery": "Data da entrega",
  "dateRead": "Data da leitura",
  "logDate": "Data do Log"
}

Exemplo de Sucesso​

{
  "notificationID": "65c863ee-a186-40c4-b659-b48cad543bd0",
  "channel": "email",
  "description": "Lido",
  "dateSent": "26/07/2023 13:34:23",
  "dateDelivery": "26/07/2023 13:34:28",
  "dateRead": "26/07/2023 13:34:50",
  "logDate": "31/08/2023 14:17:13"
}

Exemplo de Falha​

{
  "notificationID": "71789707-0301-429d-8932-6834f6602f10",
  "channel": "email",
  "description": "Falha no Envio/Entrega",
  "dateSent": null,
  "dateDelivery": null,
  "dateRead": null,
  "logDate": "31/08/2023 14:15:58"
}

Fluxo de tentativas​

A aplicação realizará uma chamada POST com um timeout configurado de até 15 segundos. Em caso de falha na resposta, indicada por qualquer código de status diferente de 2xx, o sistema realizará até três tentativas subsequentes, seguindo os intervalos detalhados abaixo:

  • Primeira tentativa: após 15 minutos
  • Segunda tentativa: após 1 hora
  • Terceira tentativa: após 3 horas

Após o término das três tentativas, o sistema encerrará o fluxo de entrega.