Eventos disponíves

Antes de receber eventos, configure seu endpoint em Cadastra webhook. Você pode ativar ou desativar um webhook existente a qualquer momento em Ativa/desativa um webhook, e consultar o histórico de disparos em Lista histórico de webhooks enviados.

Eventos de Webhook — NF-e

Evento	`documento`	`status`	Quando ocorre
NF-e autorizada	`nfe`	`AUTORIZADA`	Quando a NF-e é autorizada pela SEFAZ
NF-e cancelada	`nfe`	`CANCELADA`	Quando o cancelamento é autorizado pela SEFAZ
Envio rejeitado ou denegado	`nfe`	`FALHA_EMISSAO` ou `DENEGADA`	Quando a SEFAZ rejeita ou denega a NF-e
Cancelamento rejeitado	`nfe`	`AUTORIZADA`	Quando o pedido de cancelamento é recusado — a nota permanece autorizada

Campos do body — NF-e

Campo	Tipo	Descrição
`documento`	`string`	Tipo do documento. Sempre `nfe`
`id`	`string`	Identificador interno da NF-e
`idExterno`	`string`	Identificador externo informado na integração, quando houver
`dataEmissao`	`string`	Data/hora de emissão em UTC. Formato: `yyyy-MM-dd'T'HH:mm:ss'Z'`
`dataCancelamento`	`string`	Data/hora do cancelamento. Enviado apenas em cancelamento autorizado
`status`	`string`	Status atual da NF-e
`emitente`	`string`	CNPJ do emitente
`destinatario`	`string`	CPF/CNPJ do destinatário, quando houver
`valorTotal`	`number`	Valor total da NF-e. Enviado em eventos autorizados e cancelados
`numero`	`number`	Número da NF-e. Enviado em eventos autorizados e cancelados
`serie`	`string`	Série da NF-e. Enviada em eventos autorizados e cancelados
`chave`	`string`	Chave de acesso da NF-e. Enviada em eventos autorizados e cancelados
`mensagem`	`string`	Mensagem descritiva do evento
`pdf`	`string`	URL para download do DANFE. Enviada em eventos autorizados e cancelados
`xml`	`string`	URL para download do XML. Enviada em eventos autorizados e cancelados
`metadados`	`object`	Metadados adicionais, se existirem

Exemplos de body — NF-e

NF-e autorizada

{
  "documento": "nfe",
  "id": "64f1a7c8e9b123456789abcd",
  "idExterno": "pedido-1001",
  "dataEmissao": "2026-05-20T14:30:00Z",
  "status": "AUTORIZADA",
  "emitente": "12345678000199",
  "destinatario": "98765432000188",
  "valorTotal": 259.90,
  "numero": 12345,
  "serie": "1",
  "chave": "43260512345678000199550010000123451000123456",
  "mensagem": "NFe autorizada com sucesso",
  "pdf": "https://api.digisan.com.br/api/v1/nfe/64f1a7c8e9b123456789abcd/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfe/64f1a7c8e9b123456789abcd/xml"
}

NF-e cancelada

{
  "documento": "nfe",
  "id": "64f1a7c8e9b123456789abcd",
  "idExterno": "pedido-1001",
  "dataEmissao": "2026-05-20T14:30:00Z",
  "dataCancelamento": "2026-05-20T15:10:00Z",
  "status": "CANCELADA",
  "emitente": "12345678000199",
  "destinatario": "98765432000188",
  "valorTotal": 259.90,
  "numero": 12345,
  "serie": "1",
  "chave": "43260512345678000199550010000123451000123456",
  "mensagem": "NFe cancelada com sucesso",
  "pdf": "https://api.digisan.com.br/api/v1/nfe/64f1a7c8e9b123456789abcd/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfe/64f1a7c8e9b123456789abcd/xml"
}

Envio rejeitado

{
  "documento": "nfe",
  "id": "64f1a7c8e9b123456789abcd",
  "idExterno": "pedido-1001",
  "dataEmissao": "2026-05-20T14:30:00Z",
  "status": "FALHA_EMISSAO",
  "emitente": "12345678000199",
  "destinatario": "98765432000188",
  "mensagem": "Rejeição: total da NF difere do somatório dos itens"
}

NF-e denegada

{
  "documento": "nfe",
  "id": "64f1a7c8e9b123456789abcd",
  "idExterno": "pedido-1001",
  "dataEmissao": "2026-05-20T14:30:00Z",
  "status": "DENEGADA",
  "emitente": "12345678000199",
  "destinatario": "98765432000188",
  "mensagem": "Uso denegado: irregularidade fiscal do emitente"
}

Cancelamento rejeitado

{
  "documento": "nfe",
  "id": "64f1a7c8e9b123456789abcd",
  "idExterno": "pedido-1001",
  "dataEmissao": "2026-05-20T14:30:00Z",
  "status": "AUTORIZADA",
  "emitente": "12345678000199",
  "destinatario": "98765432000188",
  "mensagem": "Rejeição: prazo de cancelamento superior ao permitido"
}

Eventos de Webhook — NFS-e

Evento	`documento`	`status`	Quando ocorre
NFS-e autorizada	`nfse`	`AUTORIZADA`	Quando a NFS-e é autorizada pela prefeitura
NFS-e cancelada	`nfse`	`CANCELADA`	Quando o cancelamento é autorizado
Envio rejeitado	`nfse`	`FALHA_EMISSAO`	Quando a prefeitura rejeita a NFS-e
Cancelamento rejeitado	`nfse`	`FALHA_CANCELAMENTO`	Quando o pedido de cancelamento é recusado

Campos do body — NFS-e

Campo	Tipo	Descrição
`documento`	`string`	Tipo do documento. Sempre `nfse`
`id`	`string`	Identificador interno da NFS-e
`idExterno`	`string`	Identificador externo informado na integração, quando houver
`chaveAcesso`	`string`	Chave de acesso da NFS-e, quando disponível
`idDps`	`string`	Identificador da DPS, quando disponível
`emissao`	`string`	Data/hora de emissão em UTC. Formato: `yyyy-MM-dd'T'HH:mm:ss'Z'`
`cancelamento`	`string`	Data/hora do cancelamento. Enviado apenas em cancelamento autorizado
`status`	`string`	Status atual da NFS-e
`prestador`	`string`	CNPJ do prestador
`tomador`	`string`	CPF/CNPJ do tomador, quando houver
`valorLiquido`	`number`	Valor líquido do serviço. Enviado em eventos autorizados e cancelados
`numero`	`string`	Número da NFS-e. Enviado em eventos autorizados e cancelados
`serie`	`string`	Série da NFS-e. Enviada em eventos autorizados e cancelados
`lote`	`string`	Número do lote, quando houver
`codigoVerificacao`	`string`	Código de verificação da NFS-e
`mensagem`	`string`	Mensagem descritiva do evento
`pdf`	`string`	URL para download do PDF. Enviada em eventos autorizados e cancelados
`xml`	`string`	URL para download do XML. Enviada em eventos autorizados e cancelados
`metadados`	`object`	Metadados adicionais, quando existirem

Exemplos de body — NFS-e

NFS-e autorizada

{
  "documento": "nfse",
  "id": "65a2b8d9e9b123456789abcd",
  "idExterno": "os-2001",
  "chaveAcesso": "35260512345678000199000000000000000000000001",
  "idDps": "DPS-123456",
  "emissao": "2026-05-20T14:30:00Z",
  "status": "AUTORIZADA",
  "prestador": "12345678000199",
  "tomador": "98765432000188",
  "valorLiquido": 1500.75,
  "numero": "9876",
  "serie": "A",
  "lote": "456",
  "codigoVerificacao": "ABC123XYZ",
  "mensagem": "NFSe autorizada com sucesso",
  "pdf": "https://api.digisan.com.br/api/v1/nfse/65a2b8d9e9b123456789abcd/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfse/65a2b8d9e9b123456789abcd/xml",
  "metadados": {
    "origem": "integracao",
    "pedido": "2001"
  }
}

NFS-e cancelada

{
  "documento": "nfse",
  "id": "65a2b8d9e9b123456789abcd",
  "idExterno": "os-2001",
  "chaveAcesso": "35260512345678000199000000000000000000000001",
  "idDps": "DPS-123456",
  "emissao": "2026-05-20T14:30:00Z",
  "cancelamento": "2026-05-20T16:45:00Z",
  "status": "CANCELADA",
  "prestador": "12345678000199",
  "tomador": "98765432000188",
  "valorLiquido": 1500.75,
  "numero": "9876",
  "serie": "A",
  "lote": "456",
  "codigoVerificacao": "ABC123XYZ",
  "mensagem": "NFSe cancelada com sucesso",
  "pdf": "https://api.digisan.com.br/api/v1/nfse/65a2b8d9e9b123456789abcd/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfse/65a2b8d9e9b123456789abcd/xml",
  "metadados": {
    "origem": "integracao",
    "pedido": "2001"
  }
}

Envio rejeitado

{
  "documento": "nfse",
  "id": "65a2b8d9e9b123456789abcd",
  "idExterno": "os-2001",
  "emissao": "2026-05-20T14:30:00Z",
  "status": "FALHA_EMISSAO",
  "prestador": "12345678000199",
  "tomador": "98765432000188",
  "mensagem": "Rejeição: código de serviço inválido para o município",
  "metadados": {
    "origem": "integracao",
    "pedido": "2001"
  }
}

Cancelamento rejeitado

{
  "documento": "nfse",
  "id": "65a2b8d9e9b123456789abcd",
  "idExterno": "os-2001",
  "emissao": "2026-05-20T14:30:00Z",
  "status": "FALHA_CANCELAMENTO",
  "prestador": "12345678000199",
  "tomador": "98765432000188",
  "mensagem": "Rejeição: NFSe não pode ser cancelada após o prazo permitido",
  "metadados": {
    "origem": "integracao",
    "pedido": "2001"
  }
}

Resumo dos status por documento

Documento	Status possíveis
NF-e	`AUTORIZADA`, `CANCELADA`, `FALHA_EMISSAO`, `DENEGADA`
NF-e — cancelamento rejeitado	`AUTORIZADA` com mensagem de rejeição
NFS-e	`AUTORIZADA`, `CANCELADA`, `FALHA_EMISSAO`, `FALHA_CANCELAMENTO`

Diferenças entre NF-e e NFS-e no payload

Aspecto	NF-e	NFS-e
Campo de emissão	`dataEmissao`	`emissao`
Campo de cancelamento	`dataCancelamento`	`cancelamento`
Participante emissor	`emitente`	`prestador`
Participante receptor	`destinatario`	`tomador`
Valor	`valorTotal`	`valorLiquido`
Identificador fiscal	`chave`	`chaveAcesso`
Número	`number` (inteiro)	`string` (texto)
Falha no cancelamento	Mantém status `AUTORIZADA`	Envia status `FALHA_CANCELAMENTO`

Eventos disponíves

Eventos de Webhook — NF-e#

Campos do body — NF-e#

Exemplos de body — NF-e#

NF-e autorizada#

NF-e cancelada#

Envio rejeitado#

NF-e denegada#

Cancelamento rejeitado#

Eventos de Webhook — NFS-e#

Campos do body — NFS-e#

Exemplos de body — NFS-e#

NFS-e autorizada#

NFS-e cancelada#

Envio rejeitado#

Cancelamento rejeitado#

Resumo dos status por documento#

Diferenças entre NF-e e NFS-e no payload#

Eventos de Webhook — NF-e

Campos do body — NF-e

Exemplos de body — NF-e

NF-e autorizada

NF-e cancelada

Envio rejeitado

NF-e denegada

Cancelamento rejeitado

Eventos de Webhook — NFS-e

Campos do body — NFS-e

Exemplos de body — NFS-e

NFS-e autorizada

NFS-e cancelada

Envio rejeitado

Cancelamento rejeitado

Resumo dos status por documento

Diferenças entre NF-e e NFS-e no payload