Webhooks
Os avisos
Cadastre uma URL no portal e receba um POST quando o evento chega a um estado final. Uma URL por ambiente, cada uma com o seu segredo whsec_….
POST
https://sua-url/webhooks/enviaesocial
Destino
https na porta 443, com IP público
Corpo
application/json
Responda
2xxem até 10 s
Tipos
evt
event.processed
O governo processou: PROCESSED_SUCCESS com receipt ou PROCESSED_ERROR com occurrences.
evt
event.failed
Não chegou a ser processado: BATCH_REJECTED, GENERATION_ERROR (o XML não passou no XSD) ou PERMANENTLY_FAILED.
evt
ping
O botão "testar" do portal.
O corpo
uuid
texto
O da entrega; repete em todas as tentativas.
type
texto
O tipo do aviso.
created_at
data
Quando o aviso foi criado.
data.event
objeto
O mesmo objeto de GET /v1/events/{uuid}, no estado daquele instante.
O corpo não traz o ambiente: ele vem no header
X-Enviaesocial-Environment.