Callback

A ferramenta utiliza o mecanismo de callback para notificar automaticamente o sistema do cliente sempre que houver alteração no status de uma consulta.

Ao criar uma nova consulta, basta informar uma URL válida e acessível no sistema do cliente. Sempre que o status da requisição for atualizado, será enviada uma requisição HTTP para essa URL.

Caso a URL esteja inválida, inexistente ou indisponível, novas tentativas de envio serão realizadas até o limite configurado. Após o número máximo de tentativas sem sucesso, o envio será interrompido.

Quando o endpoint /autorequest for utilizado, serão enviados callbacks individuais para cada requisição interna gerada automaticamente. Esses retornos podem ocorrer em momentos diferentes, conforme o processamento de cada plataforma.

Formato do Callback (Default)

Estrutura enviada sempre que houver alteração de status de uma requisição individual:

Callback

{
  "action": "requestStatusChanged",
  "requestId": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
  "respondedAt": "2019-11-01T07:00:00.944Z",
  "status": "success"
}

Campos enviados:

• action: Tipo do evento disparado
• requestId: Identificador da requisição individual
• respondedAt: Data e hora da finalização do processamento
• status: Status atual (pending, success, warning ou error)

Formato do Callback (allRequests)

Quando configurado o parâmetro format: "allRequests" na criação da consulta automática, será enviado um único callback consolidado ao final do processamento, contendo todas as requisições geradas.

Callback Consolidado

{
  "action": "autoRequestFinished",
  "id": "0b3feca1-5235-4e45-a2d7-cc18fb77e33d",
  "respondedAt": "2025-07-27T16:00:01.125Z",
  "status": "finished",
  "data": {
    "id": "0b3feca1-5235-4e45-a2d7-cc18fb77e33d",
    "key": "cnj",
    "value": "1001077-15.2018.5.02.0002",
    "requests": [
      {
        "id": "f34589f6-c1d6-487d-9836-817d5e30d4b1",
        "status": "error",
        "platform": "custom",
        "query": "principal",
        "court": "trt2"
      },
      {
        "id": "0352df42-c9cb-4cff-afe2-bfe235a6af6c",
        "status": "success",
        "platform": "pje-jt-web",
        "query": "unificada",
        "court": "trt2"
      }
    ],
    "createdAt": "2025-07-27T15:59:30.240Z"
  }
}

Observações Importantes

• O envio ocorre sempre que houver mudança de status.
• Para consultas automáticas (/autorequest), múltiplos callbacks podem ser disparados.
• Recomenda-se que o endpoint do cliente:
  • Retorne HTTP 200 para confirmar o recebimento.
  • Esteja preparado para receber novas tentativas em caso de falha temporária.
• O payload pode variar conforme a plataforma e os dados disponibilizados pelo tribunal.

Consulta Manual

Caso não deseje utilizar callback, o resultado pode ser obtido manualmente através do endpoint: Visualizar por ID.

GET /v1/autorequest/{autoRequestId}