Treeunfe API B2C home pagelight logo
  1. Integrações
  2. Webhooks

Um webhook é uma URL do seu sistema que recebe um POST da Treeunfe quando um evento acontece na empresa, como uma nota autorizada ou cancelada. Assim você não precisa consultar a nota de tempos em tempos.

Você pode cadastrar o webhook pela API (POST /webhooks) ou no emissor, em Integrações → Nova → Webhook.

​
Cadastro

{
  "url": "https://seu-sistema.com.br/webhooks/treeunfe",
  "description": "Notas de serviço",
  "productName": "NFSE",
  "eventTypes": ["NFSE_AUTHORIZED", "NFSE_CANCELED"],
  "maxRetries": 5,
  "auth": { "type": "BEARER_TOKEN", "token": "SEU_TOKEN" }
}
CampoDescrição
urlURL que recebe os avisos.
eventTypesEventos que disparam o aviso. Precisam ser do mesmo produto de productName.
productNameNFE (padrão) ou NFSE. Para receber os dois, cadastre um webhook para cada produto.
maxRetriesTentativas de entrega em caso de falha (1 a 10).
authComo a Treeunfe se autentica na sua URL. Veja abaixo.

​
Eventos

  • NFS-e

  • NF-e

EventoQuando

| NFSE_AUTHORIZED | A NFS-e foi autorizada. | | NFSE_REJECTED | A NFS-e foi rejeitada. | | NFSE_PROCESSING_ERROR | Erro no processamento da NFS-e. | | NFSE_CANCELED | A NFS-e foi cancelada. | | NFSE_DISTRIBUTION_BATCH | Um lote de documentos novos chegou pela ADN. | | NFSE_DISTRIBUTION_SYNC_COMPLETED | A sincronização com a ADN terminou. |

​
Autenticação na sua URL

auth.typeCamposComo a Treeunfe envia
NONESem autenticação.
BEARER_TOKENtokenHeader Authorization: Bearer <token>.
CUSTOM_HEADERkey, valueUm header com o nome e o valor informados.
QUERY_PARAMkey, valueUm parâmetro na URL com o nome e o valor informados.

Use HTTPS e sempre configure uma autenticação. Sem ela, qualquer um que descubra a URL pode enviar avisos falsos ao seu sistema.