Serviço: Webhook de Eventos
Esse serviço é responsável por enviar a um determinado endpoint todos os eventos que ocorreram nas comunicações enviadas pela plataforma.
Segurança
O endpoint deve ser uma URL pública que responda às requisições HTTP/HTTPS.
Também é importante que a URL não esteja num contexto de VPN.
Esse endpoint pode ser autenticado por meio de headers customizados ou receber autorização do tipo basic (user e password).
Envios ao Endpoint
O envio ocorre no momento que os eventos são processados pela plataforma. Trata-se de uma requisição HTTP/HTTPS utilizando o método POST. O conteúdo pode ser um JSON ou XML contendo um ou mais eventos.
O serviço tenta enviar os eventos durante um período de sete dias após a primeira tentativa de envio. O intervalo entre as tentativas de envio é incrementado a cada falha, seguindo a tabela abaixo:
Após o período de sete dias o envio não ocorrerá mais e os dados “perdidos” podem ser solicitados através do atendimento. Os dados serão gerados em um arquivo no formato CSV e o tempo de geração dependerá do volume em questão.
Tipos de Canais
É possível receber status dos envios de comunicações via webhook pelos seguintes canais:
E-mail
SMS
WhatsApp
Print (impresso)
Tipos de Eventos
Eventos por Canal
Cada canal contém eventos específicos:
Descrição dos campos
Exemplo de retorno em JSON
Last updated