Entrega e novas tentativas

Esta página descreve como o Omni Z-API entrega os eventos ao seu endpoint e o que acontece quando a entrega falha. Vale para todos os tipos de webhook — de canal, de template e padrão — nos formatos padrão e Z-API.

​

Responda com 2xx em até 5 segundos

A entrega dá certo quando o seu endpoint responde com status 2xx em até 5 segundos. Receba o evento, guarde e responda. Faça o processamento pesado depois, fora da requisição. Uma resposta lenta conta como falha, e o evento é enviado de novo.

​

Quando o evento é enviado de novo

Cada espera conta a partir da tentativa anterior: São até 7 tentativas, dentro de 23 horas a partir do evento. Depois desse prazo, o evento não é mais enviado.

​

Headers de cada entrega

​

Deduplique pelo x-webhook-delivery-id

A mesma entrega pode chegar mais de uma vez. Isso acontece, por exemplo, quando o seu endpoint processou o evento, mas demorou mais de 5 segundos para responder. Guarde os x-webhook-delivery-id já processados por pelo menos 24 horas e descarte os repetidos.

​

A ordem de chegada não é garantida

Os eventos saem na ordem em que acontecem. Mas um evento que falhou é enviado de novo minutos ou horas depois, enquanto os eventos seguintes continuam sendo entregues. Assim, o status “lido” de uma mensagem pode chegar antes do “entregue” que falhou na primeira tentativa.

• Ordene pelo horário do evento, que vem no corpo (no formato padrão, o campo moment), e não pela hora de chegada.
• Para status, só avance: ignore um status mais antigo do que o que você já gravou.

​

Quando o seu endpoint fica fora do ar

Os eventos não se perdem: eles seguem as tentativas acima por até 23 horas. Quando o seu endpoint voltar, os eventos atrasados chegam junto com os novos. Prepare o endpoint para um volume maior por alguns minutos.