Baixar Collection

Callbacks - Escavador API - Documentação

Grupo

Detalhes dos Callbacks

Introdução

Callbacks são avisos que o Escavador dispara (Via método POST) para certos eventos que ocorrem em sua conta.

As chamadas são enviadas com content-type application/json.

A URL de callback pode ser cadastrado pelo painel da API.

Para garantir que os callbacks recebidos tem como origem a API do Escavador, você pode gerar um token no painel da API. Esse token será enviado em todos os callbacks pelo header Authorization.

Em caso de ocorrer falha na entrega do webhook na url de callback cadastrada, o Escavador irá tentar enviar novamente mais 10 vezes. Sendo assim, um total de 11 tentativas serão feitas. Cada tentativa tem um intervalo de 2n minutos, sendo n o número da tentativa.

As próximas seções descrevem os callbacks disponíveis na API do Escavador, seus campos e exemplos de payloads enviados.

Uma nova publicação foi encontrada pelo Monitoramento de Diários Oficiais e o Escavador identificou o processo

Ocorre quando um Monitoramento de Diários Oficiais encontra algum resultado novo e o Escavador identificou qual o processo na página do Diário Oficial. Você pode simular um envio desse callback para o seu servidor.

Campos enviados no callback

Parâmetro Descrição
event diario_movimentacao_nova
monitoramento Informações do Monitoramento relacionado ao resultado.
movimentacao Informações da movimentação que contém o termo/processo monitorado

Nova publicação encontrada no Monitoramento de Diários Oficiais

Ocorre quando um Monitoramento de Diários Oficiais encontra algum resultado novo e o Escavador não identificou qual é o processo na página do Diário Oficial ou não tem processo nessa página. Você pode simular um envio desse callback para o seu servidor.

Campos enviados no callback

Parâmetro Descrição
event diario_citacao_nova
monitoramento Informações do Monitoramento relacionado ao resultado.
diario Informações do Diário Oficial que contém o termo/processo monitorado
pagina_diario Informações da página e do contéudo que o termo foi encontrado

Monitoramento Atualizado

Ocorre sempre que uma busca é realizada e os dados do processo são atualizados em um Monitoramento do site do Tribunal

Campos enviados no callback

Parâmetro Descrição
event update_time
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.updated_at Data da atualização

Processo encontrado no Monitoramento do site do Tribunal

Quando um Monitoramento do site do Tribunal é criado para o tipo UNICO (numeração CNJ do Processo), o Escavador vai procurar pela existência daquele processo nos sistemas dos Tribunais e pode encontrar ou não o processo.

Campos enviados no callback

Parâmetro Descrição
event update_status
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.status FOUND: O processo foi encontrado e está sendo monitorado.
NOT_FOUND: O processo não foi encontrado e não será monitorado.
SENHA_INVALIDA: Senha enviada é inválida e processo não será monitorado.

OBS: A combinação instancia + extra_instancia faz a diferenciação para 2 instâncias do mesmo grau

Novo andamento encontrado no Monitoramento do site do Tribunal

Ocorre quando um Monitoramento do site do Tribunal do tipo UNICO (numeração CNJ do Processo) encontra um novo andamento.

Campos enviados no callback

Parâmetro Descrição
event movimentacao_nova
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.id ID único que identifica o andamento do processo
event_data.data Data do andamento
event_data.conteudo Conteúdo do andamento

Andamento Removido no Monitoramento do site do Tribunal

Ocorre quando não encontramos uma movimentação que estava na verificação anterior de um Monitoramento do site do Tribunal.

Campos enviados no callback

Parâmetro Descrição
event movimentacao_removida
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.id ID único que identifica o andamento do processo
event_data.data Data do andamento
event_data.conteudo Conteúdo do andamento

Nova informação da capa processo encontrada no Monitoramento do site do Tribunal

Ocorre quando um Monitoramento do site do Tribunal do tipo UNICO (numeração CNJ do Processo) encontra uma informação nova na capa do processo. São os valores que vem no atributo dados das informações do processo.

Campos enviados no callback

Parâmetro Descrição
event processo_dado_novo
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.tipo Título
event_data.dado Conteúdo

Informação de capa de processo removida no Monitoramento do site do Tribunal

Ocorre quando encontramos um dado que estava na verificação anterior. Dados são as informações que salvamos do sistema do Tribunal que não se encaixam como cabeçalhos. Elas são informações avulsas que costumam ser diferentes entre os sistema e os Tribunais

Campos enviados no callback

Parâmetro Descrição
event processo_dado_removido
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.tipo Tipo do dado encontrado
event_data.dado Valor do dado encontrado

Informação de capa de processo alteradas no Monitoramento do site do Tribunal

Ocorre quando encontramos um campo da capa do processo diferente da verificação anterior. Os campos do cabeçalho são area, assunto, classe, orgao_julgador, data_distribuicao, valor_causa, url.

Campos enviados no callback

Parâmetro Descrição
event update_cabecalho
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.valor_antigo Valor encontrado na busca anterior
event_data.valor_novo Valor encontrado na última busca
event_data.data_alteracao Data em que foi encontrado a mudança

Nova instancia de processo encontrada em Monitoramento do site do Tribunal

Ocorre quando identificamos uma nova instância do processo. É uma notificação semelhante ao update_status.

Campos enviados no callback

Parâmetro Descrição
event nova_instancia
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data Dados encontrados do processo

Processo entrou ou saiu de segredo de justiça no Monitoramento do site do Tribunal

Ocorre quando um Monitoramento do site do Tribunal do tipo UNICO (numeração CNJ do Processo) identifica que o processo entrou ou saiu de segredo de justiça.

Campos enviados no callback

Parâmetro Descrição
event update_segredo
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.segredo true ou false

Processo Arquivado

Ocorre quando identificamos o arquivamento do processo

Campos enviados no callback

Parâmetro Descrição
event processo_arquivado
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.arquivado Sempre será true
event_data.data_arquivamento Data do arquivamento (pode ser null)

Processo Desarquivado

Ocorre quando identificamos que o processo foi desarquivado

Campos enviados no callback

Parâmetro Descrição
event processo_desarquivado
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data.arquivado Sempre será false
event_data.data_arquivamento Sempre será null

Novo envolvido encontrado no Monitoramento do site do Tribunal

Ocorre quando um Monitoramento do site do Tribunal do tipo UNICO (numeração CNJ do Processo) encontra um novo envolvido no processo.

Campos enviados no callback

Parâmetro Descrição
event envolvido_novo
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data Informações do envolvido
event_data.tipo Tipo do Envolvido
event_data.nome Nome do Envolvido
event_data.principal Booleano que indica se envolvido é um dos principais participantes do

processo ou não event_data.polo | Polo do envolvido (ATIVO ou PASSIVO) event_data.documento | CPF ou CNPJ do envolvido event_data.advogado_de | OPCIONAL: Cliente do envolvido (o envolvido é advogado) event_data.oabs | OPCIONAL: OABs do advogado

Envolvido removido no Monitoramento do site do Tribunal

Ocorre quando um envolvido encontrado em uma verificação anterior não foi encontrado em um Monitoramento do site do Tribunal

Campos enviados no callback

Parâmetro Descrição
event envolvido_removido
processo Informações da instância e do processo
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data Informações do envolvido
event_data.tipo Tipo do Envolvido
event_data.nome Nome do Envolvido
event_data.principal Booleano que indica se envolvido é um dos principais participantes do

processo ou não event_data.polo | Polo do envolvido (ATIVO ou PASSIVO) event_data.documento | CPF ou CNPJ do envolvido event_data.advogado_de | OPCIONAL: Cliente do envolvido (o envolvido é advogado) event_data.oabs | OPCIONAL: OABs do advogado

Novo processo encontrado no Monitoramento do site do Tribunal

Ocorre quando um Monitoramento do site do Tribunal do tipo NUMDOC ou NOME (Nome, CPF ou CNPJ) encontra um novo processo.

Campos enviados no callback

Parâmetro Descrição
event novo_processo_envolvido
envolvido Informações do nome ou documento monitorado
app.id Id do seu monitoramento
app.monitor Informações do seu monitoramento
event_data Informações do processo encontrado

Resultado da busca assíncrona do processo no site do Tribunal

Ocorre quando uma busca assíncrona do processo no site do Tribunal encontra as informações do processo e o usuário marcou a opção de receber por callback. Ou caso não encontre depois de algumas tentativas.

Campos enviados no callback

Parâmetro Descrição
event resultado_processo_async
status SUCESSO ou ERRO
resposta Informações do processo

Resultado da busca assíncrona de nome do envolvido no site do Tribunal

Ocorre quando uma busca assíncrona do nome do envolvido no site do Tribunal encontra os processos e o usuário marcou a opção de receber por callback.

Campos enviados no callback

Parâmetro Descrição
event resultado_busca_nome_async
status SUCESSO ou ERRO
resposta Informações dos processos encontrados

Resultado da busca assíncrona por CPF ou CNPJ no site do Tribunal

Ocorre quando uma busca assíncrona por CPF ou CNPJ no no site do Tribunal encontra os processos e o usuário marcou a opção de receber por callback.

Campos enviados no callback

Parâmetro Descrição
event resultado_busca_documento_async
status SUCESSO ou ERRO
resposta Informações dos processos encontrados

Resultado da busca assíncrona por OAB no site do Tribunal

Ocorre quando uma busca assíncrona por OAB no no site do Tribunal encontra os processos e o usuário marcou a opção de receber por callback.

Campos enviados no callback

Parâmetro Descrição
event resultado_busca_oab_async
status SUCESSO ou ERRO
resposta Informações dos processos encontrados