Upgrade do sistema de Duplicatas
  • šŸŽ‰Boas-vindas!
  • Acesso aos Ambientes
  • šŸ–±ļøOperaƧƵes bĆ”sicas
    • Carteiras
    • Contatos
    • Faturamento
    • Canais de integraĆ§Ć£o
  • šŸ–„ļøAƧƵes de usuĆ”rio
    • Dados do Portal 1.0
      • Chamado para Base HistĆ³rica
    • Acessos
      • Tipos de acesso
        • Tokens de acesso
        • Cadastro de novo usuĆ”rio
        • AlteraĆ§Ć£o em perfil de usuĆ”rio cadastrado
        • Cadastro de novo detentor/carteira
        • Editar e excluir um detentor/carteira
    • Layouts de Interfaces
      • Registro de Duplicata Mercantil
      • Registro de Duplicata de ServiƧo
      • Registro de Duplicata de ServiƧo -CTe
      • AvaliaĆ§Ć£o - Duplicata Mercantil
      • AvaliaĆ§Ć£o - Duplicata de ServiƧo
      • AvaliaĆ§Ć£o - Duplicata de ServiƧo - CTe
      • AtualizaĆ§Ć£o de Registro
    • Trilha do Desenvolvedor
      • APIs | OrientaƧƵes Gerais
        • APIs de AvaliaĆ§Ć£o
          • AvaliaƧƵes de Duplicatas em Lote
            • SolicitaĆ§Ć£o de AvaliaĆ§Ć£o de Duplicatas em Lote
            • Consulta de Lotes de AvaliaƧƵes
              • Consulta de AvaliaƧƵes - itens invĆ”lidos
              • Consulta de AvaliaƧƵes - itens recebidos
              • Consulta de AvaliaƧƵes - arquivo de retorno (download)
              • Consulta de AvaliaƧƵes - arquivo de retorno (download resumido)
          • AvaliaƧƵes por chave de nota em Lote
            • SolicitaĆ§Ć£o de AvaliaĆ§Ć£o por chave de nota em Lote
          • Consulta de dados das AvaliaƧƵes
            • Busca de AvaliaƧƵes de Duplicatas Mercantis
            • Consulta de dados de Documento Fiscal EletrĆ“nico (DF-e)
            • Consulta de dados das partes
            • Consulta dos Indicadores de ConsistĆŖncia
            • Consulta de Eventos da AvaliaĆ§Ć£o
          • Busca de AvaliaƧƵes de ConstataƧƵes
        • APIs de Registro
          • Registro de OperaƧƵes e Duplicatas em lote
            • SolicitaĆ§Ć£o de Registros em Lote
            • Consulta de SolicitaƧƵes de lotes de Registros
            • Consulta de Registros InvĆ”lidos
          • Consulta de dados dos Registros
            • Busca de Registros de Duplicata Mercantil
            • Consulta do Registro
            • Consulta de Eventos do registro
          • Consulta de RecebĆ­veis
          • Consulta de AtualizaĆ§Ć£o de AvaliaƧƵes
        • APIs de AtualizaƧƵes de Registro
          • AtualizaƧƵes de ConclusĆ£o de Registros
            • SolicitaĆ§Ć£o de AtualizaƧƵes de ConclusĆ£o de Registros em Lote
            • Consulta de lotes de AtualizaƧƵes de ConclusĆ£o de Registros
            • Consulta de AtualizaƧƵes de ConclusĆ£o de Registros InvĆ”lidos
            • Consulta de AtualizaƧƵes de ConclusĆ£o de Registros Recebidos
            • Busca de ConclusƵes de Registro
          • AtualizaƧƵes NĆ£o Conclusivas de Registros
            • SolicitaĆ§Ć£o de AtualizaƧƵes NĆ£o Conclusivas de Registros em Lote
            • Consulta de Lotes de SolicitaƧƵes de AtualizaƧƵes NĆ£o Conclusivas de Registros
            • Consulta de AtualizaƧƵes NĆ£o Conclusivas de Registros InvĆ”lidos
            • Consulta de AtualizaƧƵes NĆ£o Conclusivas de Registros Recebidos
            • Busca de AtualizaƧƵes NĆ£o-Conclusivas
          • AtualizaƧƵes Anulativas de Registros
            • SolicitaĆ§Ć£o de AtualizaƧƵes Anulativas de Registros em Lote
            • Consulta de Lotes de SolicitaƧƵes de AtualizaƧƵes Anulativas de Registros
            • Consulta de AtualizaƧƵes Anulativas de Registros InvĆ”lidos
            • Consulta de AtualizaƧƵes Anulativas de Registros Recebidos
            • Busca de Cancelamentos de Registro
        • API de ConciliaĆ§Ć£o
        • API Webhook
    • AƧƵes no Portal
      • SolicitaĆ§Ć£o de avaliaĆ§Ć£o
      • Registro de ativo
      • Solicitar Opt-in
      • Consulta de agenda
      • ConciliaĆ§Ć£o
      • RelatĆ³rio de ConciliaĆ§Ć£o
      • Integrar com arquivos
        • Processamento de AvaliaĆ§Ć£o
        • Processamento de Registro
      • Consultas
        • Consulta Contratos
        • Consulta de AvaliaƧƵes e Registros
          • AvaliaĆ§Ć£o
          • Registro
  • šŸ’¬SUPORTE
    • Atendimento ao Cliente
      • FAQ
    • GlossĆ”rio
    • DicionĆ”rio de Erros
      • Grade HorĆ”ria
    • Dados de processamento
Powered by GitBook
On this page
  1. AƧƵes de usuƔrio
  2. Trilha do Desenvolvedor
  3. APIs | OrientaƧƵes Gerais

API Webhook

PreviousAPI de ConciliaĆ§Ć£oNextAƧƵes no Portal

Last updated 5 months ago

Para que vocĆŖ possa receber os dados via Webhook, Ć© necessĆ”rio que a sua empresa tenha este canal cadastrado no Portal. Caso nĆ£o o tenha, entre em contato com o time de OperaƧƵes.

Abaixo, segue a API assim como a estrutura de retorno de cada um deles, assim como a descriĆ§Ć£o dos campos.

šŸ–„ļø
Exemplo do funcionamento no fluxo de envio de lotes de registros

Receber eventos de finalizaĆ§Ć£o de processamento de lotes de registro e atualizaĆ§Ć£o de Duplicatas.

Webhook para receber eventos de finalizaĆ§Ć£o de processamento de lotes de registro e atualizaĆ§Ć£o de Duplicatas.

post

/webhook

Body
dataHoraEventostring Ā· date-timerequired

Data e hora do evento.

tipoEventostring Ā· enumrequired

Tipo de evento relacionado ao lote de registros.

Options: lotes-de-registros, lotes-de-atualizacoes-conclusivas-de-registro, lotes-de-atualizacoes-nao-conclusivas-de-registro, lotes-de-cancelamentos-de-registro
eventoobjectrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/webhook' \
  --header 'Content-Type: application/json' \
  --data '{"dataHoraEvento":"2025-02-22T08:57:43.061Z","tipoEvento":"lotes-de-registros","evento":{"listaItensProcessados":[{}],"listaItensInvalidos":[{"erros":[null]}]}}'
200
400
500
No body

Sucesso ao receber o evento.