Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-26125148541.3 KB
Webhooks

Criar

Cria um novo gatilho para receber notificações de eventos.

post/hooks

Request body

cnpjstring

CNPJ da empresa

cpfstring

CPF do prestador de serviço

event'nfe' | 'nfse' | 'nfsen' | 'nfce_contingencia' | 'nfe_recebida' | 'nfe_recebida_falha_consulta' | 'nfse_recebida' | 'cte_recebida' | 'inutilizacao' | 'cte' | 'mdfe' | 'nfcom' | 'nfsen_recebida' | 'dce' required

Evento a ser monitorado

urlstring uri required

URL que receberá as notificações

authorizationstring nullable

Valor a ser enviado no cabeçalho de autorização

authorization_headerstring nullable

Nome do cabeçalho HTTP a ser utilizado para enviar o campo authorization

Example request

{
  "cnpj": "12345678000123",
  "event": "nfe",
  "url": "http://minha.url/nfe"
}

Response

Gatilho criado com sucesso

idstring
urlstring uri
authorizationstring nullable
authorization_headerstring nullable
event'nfe' | 'nfse' | 'nfsen' | 'nfce_contingencia' | 'nfe_recebida' | 'nfe_recebida_falha_consulta' | 'nfse_recebida' | 'cte_recebida' | 'inutilizacao' | 'cte' | 'mdfe' | 'nfcom'

Evento monitorado

cnpjstring

CNPJ vinculado ao gatilho

cpfstring

CPF vinculado ao gatilho

Example response

{
  "id": "Vj5rmkBq",
  "url": "http://minha.url/nfe",
  "authorization": null,
  "authorization_header": null,
  "event": "nfe",
  "cnpj": "12345678000123"
}