Referência Webhooks
Operações da API de webhooks
Cada operação tem uma página com o que ela faz, os campos e um exemplo pronto. Para testar e navegar pelos modelos, use a referência interativa.
Configurar webhooks
Diga para onde mandar os avisos e quais avisos você quer receber.
- Ver o webhook do integrador
GET /webhook - Configurar o webhook do integrador
PUT /webhook - Ver o webhook da empresa
GET /empresas/{cnpj}/webhook - Configurar o webhook da empresa
PUT /empresas/{cnpj}/webhook - Remover o webhook da empresa
DELETE /empresas/{cnpj}/webhook - Enviar um webhook de teste
POST /webhook/teste
Histórico de envios
Veja cada aviso enviado, as tentativas e a resposta do seu sistema, e reenvie quando precisar.
- Listar os webhooks enviados
GET /webhooks/eventos - Reenviar um webhook
POST /webhooks/eventos/{id}/reenvio
Validar a assinatura
As chaves públicas que o seu sistema usa para conferir que o aviso veio da Weesy.
- Obter as chaves para validar a assinatura
GET /webhooks/chaves
Avisos que enviamos
O que chega no endereço do seu sistema a cada mudança na nota. Todo aviso é um POST com o mesmo envelope (id, tipo, ocorridoEm, empresa) e a nota em dados, assinado em ES256. Responda 2xx em até 10 segundos.
- NFS-e recebida
nfse.recebida - NFS-e autorizada
nfse.autorizada - NFS-e rejeitada pela prefeitura
nfse.rejeitada - Não foi possível falar com a prefeitura
nfse.erro - NFS-e cancelada
nfse.cancelada - Cancelamento recusado pela prefeitura
nfse.cancelamento_rejeitado - Aviso de teste
teste