Callback

A API de Monitoramento (Push) utiliza callback/webhook para enviar automaticamente as atualizações de um processo monitorado.

Ao cadastrar um processo, é necessário informar uma URL válida do cliente. Sempre que uma modificação for identificada no processo, um callback será enviado para essa URL.

Caso o endpoint esteja inválido, inexistente ou offline, a API realizará novas tentativas de envio até atingir o limite configurado.

Também disponibilizamos uma rota específica para testar o callback, permitindo validar conectividade, autenticação e estrutura do payload antes de utilizar em produção.

Quando o Callback é Enviado

O envio ocorre sempre que:

• Um novo andamento é identificado
• Alguma informação da capa é alterada
• Propriedades são atualizadas
• Partes são incluídas ou modificadas
• A estrutura de dados sofre alteração relevante

Estrutura do Payload

Abaixo está o modelo estrutural do callback enviado pelo monitoramento.

Exemplo de Callback

{
  "id": "uuid",
  "cnj": "string",
  "ignore": "boolean",
  "createdAt": "datetime",
  "info": [
    {
      "id": "uuid",
      "source": "string",
      "platform": "string",
      "search": "string",
      "query": "string",
      "sourceTag": "string",
      "platformTag": "string",
      "searchTag": "string",
      "queryTag": "string",
      "lastResponse": "datetime",
      "data": [
        {
          "cover": [
            {
              "id": "uuid",
              "description": "string",
              "value": "string",
              "index": "string",
              "confirmed": "boolean"
            }
          ],
          "properties": {
            "number": "string",
            "class": "string",
            "subject": "string",
            "district": "string",
            "origin": "string",
            "startAt": "datetime",
            "judge": "string",
            "cnj": "string"
          },
          "propertiesArray": [
            {
              "id": "uuid",
              "key": "string",
              "value": "string",
              "index": "string",
              "confirmed": "boolean"
            }
          ],
          "people": [
            {
              "id": "uuid",
              "pole": "string",
              "description": "string | null",
              "name": "string",
              "doc": "string | null",
              "index": "string",
              "confirmed": "boolean",
              "lawyers": [
                {
                  "name": "string",
                  "oab": "string",
                  "uf": "string"
                }
              ]
            }
          ],
          "steps": [
            {
              "id": "uuid",
              "timestamp": "datetime",
              "title": "string",
              "description": "string | null",
              "actionBy": "string",
              "index": "string",
              "confirmed": "boolean"
            }
          ]
        }
      ]
    }
  ]
}

Observações Importantes

• O campo confirmed indica se o item já foi confirmado pelo cliente via endpoint de confirmação.
• O array info representa cada abrangência/plataforma monitorada.
• O array data pode conter múltiplos registros dependendo da estrutura retornada pela plataforma.
• O payload em produção conterá valores reais, porém seguirá exatamente este formato estrutural.

Caso não deseje utilizar callback, é possível consultar manualmente os dados pelos endpoints de monitoramento disponíveis na documentação.