Callback / Webhook
callbacks
Quando uma busca ou um monitoramento e feito pela API da JUDIT enviamos um retorno com as informações encontradas. Para que todas as respostas das solicitações sejam enviadas a um único webhook, o cadstro deve ser realizado entrando em contato com nosso suporte: Judit. Alternativamente, o webhook também pode ser especificado adicionando o parâmetro callback_url no payload da requisição, conforme o exemplo abaixo:
O parâmetro “with_attachments” deve ser aplicado apenas para consultas processuais, ou seja, quando o campo “search_type” for definido como “lawsuit_cnj”.
Realizamos uma solicitação POST para o webhook, enviando as respostas conforme os resultados da sua busca. O envio ocorre de forma incremental, à medida que as respostas são geradas, e é concluído quando o status da requisição é atualizado para “completed”.
Exemplo de payload com o tipo de resposta:
O campo reference_type
pode variar entre request
ou tracking
.
No caso de uma busca por documento, seja ele CPF, CNPJ, OAB ou NAME e desejar receber um grupo de itens específicos, poderemos realizar uma consulta de respostas passando os filtros desejados.
Exemplo de resposta de uma busca com o “search_type” contendo o valor “lawsuit_cnj”:
Aqui está um exemplo de resposta enviada ao término do envio completo, com a mensagem de confirmação indicando que todas as respostas foram entregues. Essa mensagem final inclui o statusCode “600” e a mensagem “request_completed”, conforme ilustrado abaixo:
Caso o processo consultado tenha um ou mais processos relacionado ou em alguma outra instância, esses processos serão retornados em um array `related_lawsuits.