Endpoints de webhook
Os endereços do seu sistema que recebem os eventos. Cada endpoint tem a própria lista de eventos e o próprio segredo de assinatura.
Escoposwebhooks:escrever
# Produçãohttps://api.emissordenota.com/v1# Sandboxhttps://sandbox.api.emissordenota.com/v1Endpoints
- GET
/v1/webhooksLista os endpoints cadastrados - POST
/v1/webhooksCadastra um endpoint - POST
/v1/webhooks/{id}/testarEnvia um evento de teste - DELETE
/v1/webhooks/{id}Remove um endpoint
O objeto endpoint
idstringIdentificador do endpoint, com o prefixo wh_.
urlstringEndereço HTTPS que recebe os eventos.
eventosarrayOs eventos que o endpoint assina.
segredostringUsado para conferir a assinatura das entregas. Aparece completo só na resposta do cadastro.
ativobooleanVem false quando o endpoint está pausado e não recebe entregas.
criado_emstringData e hora do cadastro, em ISO 8601.
{ "id": "wh_5Rk8sNc2Yd", "url": "https://seusistema.com.br/webhooks/emissor", "eventos": [ "nfse.autorizada", "nfse.rejeitada", "guia.disponivel" ], "segredo": "whsec_Tz4Lm9Qx2Vb7Kc1Nw8Ry5Pd3", "ativo": true, "criado_em": "2026-11-03T11:27:40-03:00"}Cadastrar um endpoint
POST/v1/webhooks
Cria o endpoint e devolve o segredo de assinatura. Guarde o segredo na hora: ele não aparece completo de novo.
Corpo da requisição
urlstringobrigatórioPrecisa usar HTTPS e responder em até 10 segundos.
eventosarrayobrigatórioUm ou mais eventos da lista do guia de Webhooks.
descricaostringopcionalTexto livre para identificar o endpoint no painel.
curl -X POST https://api.emissordenota.com/v1/webhooks \ -H "Authorization: Bearer $EDN_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://seusistema.com.br/webhooks/emissor", "eventos": ["nfse.autorizada", "nfse.rejeitada"] }'Enviar um evento de teste
POST/v1/webhooks/{id}/testar
Dispara uma entrega com dados de exemplo, assinada com o segredo do endpoint. A resposta traz o status devolvido pelo seu servidor.
Corpo da requisição
eventostringopcionalO evento a simular. O padrão é nfse.autorizada.
{ "evento_id": "evt_2Vn6cXp9Lt", "evento": "nfse.autorizada", "status_http": 200, "duracao_ms": 184}Remover um endpoint
DELETE/v1/webhooks/{id}
Remove o endpoint e responde 204, sem corpo. As entregas pendentes para ele são descartadas.
Erros
StatusCódigoQuando
- 404webhook_nao_encontradoO id não existe nesse ambiente.
- 422url_invalidaA URL não usa HTTPS.
- 422evento_desconhecidoHá um evento fora da lista.