Ir para o conteúdo

7.1. Atualização Solicitação Agenda

🔔 Tipo de Notificação

Campo Valor
tipoNotificacao 1

🧾 Descrição

Esta notificação será enviada via POST para o endpoint de WebHook configurado previamente quando houver alguma atualização na solicitação de agenda de duplicatas. Ela informa o status atual da agenda vinculada à simulação e, quando houver falha, retorna a mensagem de erro correspondente.


📤 Payload Enviado

{
  "tipoNotificacao": 1,
  "simulacao": {
    "identificador": "B8526D13-F10E-481E-993C-1327A9C2F203",
    "statusAgenda": 1,
    "erros": ""
  }
}

🧾 Detalhamento dos Campos

Campo Tipo Descrição
tipoNotificacao integer Identifica o tipo da notificação (1 = Atualização solicitação agenda)
simulacao.identificador string GUID da simulação
simulacao.statusAgenda integer Status atual da agenda (ver StatusAgenda)
simulacao.erros string|null Mensagem de erro quando houver falha

🔢 StatusAgenda

Código Significado
1 Agenda disponível
2 Agenda vazia
3 Agenda ultrapassou tempo de publicação
4 Agenda com falha

📪 Exemplo de envio

O sistema enviará uma requisição POST para o endpoint informado pelo cliente com o seguinte corpo:

POST /webhook/duplicata-escritural HTTP/1.1
Content-Type: application/json
Authorization: Bearer {seu_token}

{
  "tipoNotificacao": 1,
  "simulacao": {
    "identificador": "B8526D13-F10E-481E-993C-1327A9C2F203",
    "statusAgenda": 1,
    "erros": ""
  }
}

🕒 Observações

  • Esta notificação é assíncrona e é enviada sempre que houver uma mudança no status da agenda.
  • O campo simulacao.identificador corresponde ao identificador retornado no momento da criação da simulação.
  • O campo simulacao.erros será preenchido apenas quando statusAgenda = 4 (Agenda com falha).