API Webhook

Exemplo do funcionamento no fluxo de envio de lotes de registros

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.

Receber eventos de finalização de processamento de lotes de registro e atualização de Duplicatas.

post

Webhook para receber eventos de finalização de processamento de lotes de registro e atualização de Duplicatas.

Body

tipoEventostring · enumRequired

Tipo de evento relacionado ao lote de registros.

Possible values:

dataHoraEventostring · date-timeRequired

Data e hora do evento.

Responses

post

HTTPcURLJavaScriptPython

POST /webhook HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "tipoEvento": "lotes-de-registros",
  "dataHoraEvento": "2025-04-26T09:48:54.167Z",
  "evento": {
    "id": "text",
    "totalItensRecebidos": 1,
    "totalItensProcessados": 1,
    "totalItensInvalidos": 1,
    "dataFinalizacao": "2025-04-26T09:48:54.167Z",
    "dataCriacao": "2025-04-26T09:48:54.167Z",
    "listaItensProcessados": [
      {
        "referenciaExterna": "text",
        "recebivelId": "text"
      }
    ],
    "listaItensInvalidos": [
      {
        "referenciaExterna": "text",
        "recebivelId": "text",
        "erros": [
          "text"
        ]
      }
    ]
  }
}

No content