1. Webhooks
DIGISAN
  • Getting Started
    • Introdução
    • Ambiente
    • Autenticação
    • Certificado Digital
    • Exemplo de requisições
    • Reforma Tributária
    • Suporte e SLA
  • Webhooks
    • Eventos disponíves
    • Cadastra webhook
      POST
    • Atualiza o cadastro de webhook
      PUT
    • Ativa/desativa um webhook
      PUT
    • Retorna os dados do webhook cadastrado
      GET
    • Lista histórico de webhooks enviados
      GET
  • Empresas
    • Cadastro de emitente/prestador
      POST
    • Atualização de emitente/prestador
      PUT
    • Obtém um emitente/prestador por CNPJ
      GET
    • Upload do certificado digital do emitente/prestador em multipart-form-data.
      POST
    • Deleta o certificado digital do emitente/prestador
      DELETE
  • NFSe
    • Emitir nota de serviço
      POST
    • Baixar XML da nota
      GET
    • Baixar PDF da nota
      GET
    • Consulta nota pelo ID
      GET
    • Solicitar cancelamento da nota
      POST
    • Consulta dados de um município homologado para emissão de NFSe
      GET
    • Consulta municípios homologados para emissão de NFSe
      GET
  • NFe
    • Emitir nota de produto
    • Baixar XML da nota
    • Baixar PDF da nota
    • Consulta nota pelo ID
    • Solicitar Carta de Correção
    • Solicitar cancelamento da nota
    • Inutilizar numeração de nota fiscal (NF-e)
  • NFC-e
    • Emitir nota de consumidor
    • Consulta nota pelo ID
    • Baixar XML da nota
    • Baixar PDF da nota
    • Solicitar cancelamento da nota
    • Inutilizar numeração de nota fiscal (NFC-e)
  • CT-e (Beta)
    • Emitir conhecimento de transporte eletrônico
    • Consulta CT-e pelo ID
    • Baixar XML do CT-e
    • Baixar PDF do DACTE
    • Solicitar Carta de Correção do CT-e
    • Solicitar cancelamento do CT-e
  • CT-e OS (Beta)
    • Emitir CT-e OS
    • Consulta CT-e OS pelo ID
    • Baixar XML do CT-e OS
    • Baixar PDF do DACTE OS
    • Solicitar Carta de Correção do CT-e OS
    • Solicitar cancelamento do CT-e OS
  • MDF-e (Beta)
    • Solicitar inclusão de DF-e no MDF-e
    • Solicitar inclusão de condutor no MDF-e
    • Solicitar encerramento do MDF-e
    • Solicitar cancelamento do MDF-e
    • Emitir Manifesto Eletrônico de Documentos Fiscais
    • Baixar XML do manifesto
    • Baixar PDF do manifesto
    • Baixar XML da última inclusão de DF-e do MDF-e
    • Baixar PDF da última inclusão de DF-e do MDF-e
    • Baixar XML da última inclusão de condutor do MDF-e
    • Baixar PDF da última inclusão de condutor do MDF-e
    • Baixar XML de encerramento do MDF-e
    • Baixar PDF de encerramento do MDF-e
    • Consulta MDF-e pelo ID
  • Raiz
  • Esquemas
    • Schemas
      • Mensagem
      • Resposta
      • ObterWebhookResponseDTO
    • Raiz
    • NovoWebhookDTO
    • WebhookResponseDTO
    • AtivarEDesativarWebHookDTO
    • AlterarCompanhiaInput
    • EnderecoCompanhia
    • CadastrarEmpresaOutput
    • CancelarNFSe
    • Endereco
    • IBSCBS do Servico
    • Municipio
    • NFSe
    • NFSeIbptDTO
    • Pais
    • Prestador
    • Servico
    • ServicoInformacaoExterior
    • Tomador
    • deducao
    • obra
    • servicoAtividadeEvento
    • tributacaoTotal
    • tributacaoTotalConteudo
    • Evento
    • InutilizarDTO
    • NumeracaoDTO
    • CBS
    • CBS Total
    • Emitente
    • Frete
    • IBS Município
    • IBS Total
    • IBS UF
    • IBSCBS Total
    • IBSCBS do Item
    • ICMS
    • IPI
    • Imposto
    • Item
    • NFe
    • NFeAjusteCompetenciaDTO
    • NFeApropriacaoCreditoPresumidoIbsZfmDTO
    • NFeCompraGovernamentalDTO
    • NFeCreditoPresumidoDTO
    • NFeCreditoPresumidoOperacaoDTO
    • NFeDuplicataDTO
    • NFeEstornoCreditoDTO
    • NFeFaturaDTO
    • NFeItemDFeReferenciadoDTO
    • NFeItemISDTO
    • NFeMonofasicoDTO
    • NFeMonofasicoDiferimentoDTO
    • NFeMonofasicoPadraoDTO
    • NFeMonofasicoRetencaoDTO
    • NFeMonofasicoRetidoDTO
    • NFePagamentoAntecipadoDTO
    • NFeReferenciada
    • NFeRetencaoICMSTransporteDTO
    • NFeTransferenciaCreditoDTO
    • NFeVeiculoDTO
    • NFeVolumeDTO
    • Pagamento
    • Total
    • Transportadora
    • Destinatario NFCe
    • NFCe
    • MDFeInclusaoDFe
    • MDFeInclusaoDFeDocumento
    • MDFeInclusaoCondutor
    • MDFeEncerramento
    • MDFeEncerramentoEvento
    • MDFeEvento
    • MDFeInclusaoCondutorEvento
    • MDFeInclusaoDocumentoFiscalEvento
    • CargaLotacao
    • DocumentoCTe
    • DocumentoMDFe
    • DocumentoNFe
    • EmbarcacaoCombinada
    • EntregaParcial
    • LocalizacaoCarga
    • MDFETotalizadores
    • MDFe
    • MDFeAereo
    • MDFeAquaviario
    • MDFeAutorizadoXml
    • MDFeCiot
    • MDFeComponentePagamento
    • MDFeCondutor
    • MDFeContratante
    • MDFeContrato
    • MDFeDadosBancarios
    • MDFeDispositivoValePedagio
    • MDFeEmitente
    • MDFeFerroviario
    • MDFeInformacoesANTT
    • MDFeInformacoesModal
    • MDFeMunicipioCarregamento
    • MDFeMunicipioDescarregamento
    • MDFePagamentoContrato
    • MDFeParcelaPagamento
    • MDFeProdutoPerigoso
    • MDFeProdutoPredominante
    • MDFeProprietarioVeiculo
    • MDFeResponsavelTecnico
    • MDFeRodoviario
    • MDFeSeguro
    • MDFeUnidadeCarga
    • MDFeUnidadeTransporte
    • MDFeValePedagio
    • MDFeVeiculoReboque
    • MDFeVeiculoTracao
    • TerminalCarregamento
    • TerminalDescarregamento
    • Trem
    • UnidadeVazia
    • Vagao
    • CadastrarCompaniaInput
    • CTeEvento
    • Correcao
    • CTeCobranca
    • CTeComponenteValor
    • CTeCompraGovernamental
    • CTeContainer
    • CTeCreditoPresumido
    • CTeDevolucaoTributo
    • CTeDiferimento
    • CTeDocumentoNFe
    • CTeDocumentosOriginarios
    • CTeDuplicata
    • CTeEmitente
    • CTeFatura
    • CTeFerrovia
    • CTeIBSCBS
    • CTeICMS
    • CTeImposto
    • CTeInformacoesCarga
    • CTeInformacoesModal
    • CTeLacre
    • CTeModalAereo
    • CTeModalAquaviario
    • CTeModalDutoviario
    • CTeModalFerroviario
    • CTeModalMultimodal
    • CTeModalRodoviario
    • CTeOS
    • CTeOSDocumentoReferenciado
    • CTeOSFretamento
    • CTeOSInformacoesServico
    • CTeOSModalRodoviario
    • CTeOSProprietarioVeiculo
    • CTeOSVeiculo
    • CTeOrdemColeta
    • CTeOutroDocumento
    • CTeParticipante
    • CTeProdutoPerigoso
    • CTeQuantidadeCarga
    • CTeReducaoAliquota
    • CTeSeguro
    • CTeTomador
    • CTeTributacaoRegular
    • CTeTributoCompartilhado
    • CTeTributosFederais
    • CTeVagao
    • CTeValePedagio
    • CTeValoresPrestacao
    • CTeVeiculo
    • CTeVeiculoNovo
    • CTe
    • ConsultaPaginadaHistoricoWebhookInput
    • NFSeCancelamentoDTO
    • NFSeResponseDTO
    • CidadeDTO
    • NFeCancelamentoDTO
    • NFeCartaCorrecaoDTO
    • NFeResponseDTO
    • NFCeResponseDTO
    • MDFeCancelamento
    • MDFeEncerramentoResponse
    • MDFeInclusaoCondutorResponse
    • MDFeInclusaoDFeDocumentoResponse
    • MDFeInclusaoDFeResponse
    • MDFeResponse
    • CTeCancelamentoDTO
    • CTeCartaCorrecaoDTO
    • CTeResponse
    • CTeOSResponse
  1. Webhooks

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 e NFC-e#

EventodocumentostatusQuando ocorre
NF-e autorizadanfe/nfceAUTORIZADAQuando a NF-e é autorizada pela SEFAZ
NF-e canceladanfe/nfceCANCELADAQuando o cancelamento é autorizado pela SEFAZ
Envio rejeitado ou denegadonfe/nfceFALHA_EMISSAO ou DENEGADAQuando a SEFAZ rejeita ou denega a NF-e
Cancelamento rejeitadonfe/nfceAUTORIZADAQuando o pedido de cancelamento é recusado, a nota permanece autorizada porém com um objeto a mais chamado cancelamento que contém as informações do cancelamento

Exemplos de body — NF-e e NFC-e#

Quando um evento se tratar de NFe o campo documento será nfe e quando for NFCe será nfce respectivamente.

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": "6a0ef6c0e8f90b3df7ffd5ae",
  "idExterno": "a6039ac0-9c9b-4eca-91d9-7c7bf026f42c",
  "dataEmissao": "2026-05-21T12:12:47Z",
  "status": "CANCELADA",
  "emitente": "03610650000147",
  "destinatario": "03610650000147",
  "valorTotal": 10,
  "numero": 5693,
  "serie": "0",
  "chave": "53260503610650000147550000000056931182540335",
  "mensagem": "NFe cancelada com sucesso",
  "pdf": "https://api.digisan.com.br/api/v1/nfe/6a0ef6c0e8f90b3df7ffd5ae/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfe/6a0ef6c0e8f90b3df7ffd5ae/xml",
  "cancelamento": {
    "status": "CANCELADO",
    "data": "2026-05-21T12:15:34Z",
    "protocolo": "353260000038035",
    "motivo": "nota emitida para testes"
  }
}

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": "69fd2e6bc8cc1248a89acfd0",
  "idExterno": "ord926g0g5",
  "dataEmissao": "2026-05-08T00:29:14Z",
  "status": "AUTORIZADA",
  "emitente": "03610650000147",
  "destinatario": "03610650000147",
  "valorTotal": 46.75,
  "numero": 5684,
  "serie": "0",
  "chave": "53260503610650000147550000000056841062023709",
  "mensagem": "Cancelamento rejeitado",
  "pdf": "https://api.digisan.com.br/api/v1/nfe/69fd2e6bc8cc1248a89acfd0/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfe/69fd2e6bc8cc1248a89acfd0/xml",
  "cancelamento": {
    "status": "REJEITADO",
    "mensagemRejeicao": "501 - Rejeicao: Prazo de Cancelamento Superior ao Previsto na Legislacao"
  }

Eventos de Webhook — NFS-e#

EventodocumentostatusQuando ocorre
NFS-e autorizadanfseAUTORIZADAQuando a NFS-e é autorizada pela prefeitura
NFS-e canceladanfseCANCELADAQuando o cancelamento é autorizado
Envio rejeitadonfseFALHA_EMISSAOQuando a prefeitura rejeita a NFS-e
Cancelamento rejeitadonfseFALHA_CANCELAMENTOQuando o pedido de cancelamento é recusado, a nota permanece autorizada porém com um objeto a mais chamado cancelamento que contém as informações do cancelamento

Exemplos de body — NFS-e#

NFS-e autorizada#

{
  "documento": "nfse",
  "id": "7b2c9d8e11445522881133b2",
  "idExterno": "ab12cd34-ef56-7890-ab12-cd34ef567890",
  "emissao": "2026-05-21T13:56:29Z",
  "status": "AUTORIZADA",
  "prestador": "12345678000195",
  "tomador": "98765432000110",
  "valorLiquido": 219.72,
  "numero": "20231",
  "serie": "1",
  "lote": "570",
  "codigoVerificacao": "ZXCVBNMAS",
  "mensagem": "NFSe autorizada com sucesso",
  "pdf": "https://api.digisan.com.br/api/v1/nfse/7b2c9d8e11445522881133b2/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfse/7b2c9d8e11445522881133b2/xml"
}

NFS-e cancelada#

{
  "documento": "nfse",
  "id": "6a0ef6c0e8f90b3df7ffd5ae",
  "idExterno": "a6039ac0-9c9b-4eca-91d9-7c7bf026f42c",
  "dataEmissao": "2026-05-21T12:12:47Z",
  "status": "CANCELADA",
  "emitente": "03610650000147",
  "tomador": "03610650000147",
  "valorTotal": 10,
  "numero": 5693,
  "serie": "0",
  "chave": "53260503610650000147550000000056931182540335",
  "mensagem": "NFe cancelada com sucesso",
  "pdf": "https://api.digisan.com.br/api/v1/nfse/6a0ef6c0e8f90b3df7ffd5ae/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfse/6a0ef6c0e8f90b3df7ffd5ae/xml",
  "cancelamento": {
    "status": "CANCELADO",
    "data": "2026-05-21T12:15:34Z",
    "protocolo": "353260000038035",
    "motivo": "nota emitida para testes"
  }
}

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": "69fd2e6bc8cc1248a89acfd0",
  "idExterno": "ord926g0g5",
  "dataEmissao": "2026-05-08T00:29:14Z",
  "status": "AUTORIZADA",
  "emitente": "03610650000147",
  "tomador": "03610650000147",
  "valorTotal": 46.75,
  "numero": 5684,
  "serie": "0",
  "chave": "53260503610650000147550000000056841062023709",
  "mensagem": "Cancelamento rejeitado",
  "pdf": "https://api.digisan.com.br/api/v1/nfse/69fd2e6bc8cc1248a89acfd0/pdf",
  "xml": "https://api.digisan.com.br/api/v1/nfse/69fd2e6bc8cc1248a89acfd0/xml",
  "cancelamento": {
    "status": "REJEITADO",
    "mensagemRejeicao": "501 - Rejeicao: Prazo de Cancelamento Superior ao Previsto na Legislacao"
  }
Modificado em 2026-05-21 14:32:54
Página anterior
Webhooks
Próxima página
Cadastra webhook
Built with