Webhook de monitoramento

Receba os eventos dos processos monitorados no seu servidor, com assinatura e novas tentativas automáticas.

Entrada: URL httpsResposta imediata

Quando usar

Tempo real

Atualize o seu sistema assim que o andamento for capturado.

Menos chamadas

Dispensa consultas periódicas para descobrir se algo mudou.

Auditoria

Cada entrega fica registrada com a resposta do seu servidor.

Valide a assinatura

Toda entrega traz o cabeçalho X-Webhook-Signature. Confira com o segredo antes de confiar no conteúdo. O guia Webhooks mostra o código.

Novas tentativas

Sem resposta 2xx em 10 segundos, tentamos de novo após 1 min, 5 min, 30 min, 2 h, 12 h e 24 h. Depois disso a entrega fica como failed e pode ser reenviada.

Pode chegar repetido

Em caso de falha de rede a mesma entrega pode chegar mais de uma vez. Use o X-Webhook-Id para ignorar repetições.

Passo 1

Configurar webhook

PUT/api/partner/v2/webhook

Cria ou troca a URL que recebe os eventos de monitoramento. A URL precisa usar https e apontar para um endereço público.

Na criação, a resposta traz o secret usado para assinar as entregas. Ele aparece uma única vez; guarde em local seguro. Trocar a URL depois não muda o segredo.

Corpo da requisição

Campo	Tipo	Descrição
`url` obrigatório	string	Endereço https que recebe os POSTs. Ex.: `https://seu-sistema.com.br/webhooks/processos`

urlstringobrigatório
Endereço https que recebe os POSTs.
Ex.: https://seu-sistema.com.br/webhooks/processos

Respostas

200URL atualizada. Na criação a resposta é 201 e inclui secret.
400URL inválida, sem https ou apontando para endereço interno (INVALID_URL)

Requisição

curl -X PUT "https://consultadeprocessos.com.br/api/partner/v2/webhook" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://seu-sistema.com.br/webhooks/processos"}'

Resposta · 200

{
  "data": {
    "url": "https://seu-sistema.com.br/webhooks/processos",
    "status": "active",
    "consecutiveFailures": 0,
    "lastSuccessAt": null,
    "lastFailureAt": null,
    "createdAt": "2026-10-15T13:00:00.000Z"
  },
  "secret": "whsec_3kq9X2mJbVt7cL1pR8sYw4nZ0aE6uH5d"
}

Passo 2

Consultar webhook

GET/api/partner/v2/webhook

Consultar webhook.

Respostas

200Webhook configurado
404Nenhum webhook configurado

Campos da resposta (7)

Campo	Tipo	Descrição
`data`	object
`data.url`	string
`data.status`	string	`activedisabled`
`data.consecutiveFailures`	integer	Tentativas seguidas sem resposta 2xx.
`data.lastSuccessAt`	string \| null
`data.lastFailureAt`	string \| null
`data.createdAt`	string

dataobject
data.urlstring
data.statusstring
activedisabled
data.consecutiveFailuresinteger
Tentativas seguidas sem resposta 2xx.
data.lastSuccessAtstring | null
data.lastFailureAtstring | null
data.createdAtstring

Requisição

curl -X GET "https://consultadeprocessos.com.br/api/partner/v2/webhook" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Passo 3

Enviar evento de teste

POST/api/partner/v2/webhook/test

Envia na hora um evento ping assinado para a URL configurada e devolve a resposta do seu servidor.

Respostas

200Resultado do envio
404Nenhum webhook ativo

Campos da resposta (4)

Campo	Tipo	Descrição
`data`	object
`data.delivered`	boolean
`data.statusCode`	integer \| null
`data.error`	string \| null

dataobject
data.deliveredboolean
data.statusCodeinteger | null
data.errorstring | null

Requisição

curl -X POST "https://consultadeprocessos.com.br/api/partner/v2/webhook/test" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{"document":"12345678901"}'

Resposta · 200

{
  "data": {
    "ok": true,
    "delivered": true,
    "statusCode": 200,
    "error": null
  }
}

Passo 4

Ativar ou pausar

PATCH/api/partner/v2/webhook

Com o webhook pausado, nenhum evento é gerado. Ao reativar, as entregas recomeçam a partir daquele momento; o que aconteceu no intervalo continua disponível em GET /api/partner/v2/monitorings/{id}/events.

Corpo da requisição

Campo	Tipo	Descrição
`status` obrigatório	string	`activedisabled` Ex.: `disabled`

statusstringobrigatório
activedisabled
Ex.: disabled

Respostas

200Situação atualizada
404Nenhum webhook configurado

Campos da resposta (7)

Campo	Tipo	Descrição
`data`	object
`data.url`	string
`data.status`	string	`activedisabled`
`data.consecutiveFailures`	integer	Tentativas seguidas sem resposta 2xx.
`data.lastSuccessAt`	string \| null
`data.lastFailureAt`	string \| null
`data.createdAt`	string

dataobject
data.urlstring
data.statusstring
activedisabled
data.consecutiveFailuresinteger
Tentativas seguidas sem resposta 2xx.
data.lastSuccessAtstring | null
data.lastFailureAtstring | null
data.createdAtstring

Requisição

curl -X PATCH "https://consultadeprocessos.com.br/api/partner/v2/webhook" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{"status":"disabled"}'

Passo 5

Gerar novo segredo

POST/api/partner/v2/webhook/secret

Gera outro segredo de assinatura. O anterior deixa de valer na mesma hora.

Respostas

200Novo segredo
404Nenhum webhook configurado

Requisição

curl -X POST "https://consultadeprocessos.com.br/api/partner/v2/webhook/secret" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{"document":"12345678901"}'

Passo 6

Listar entregas

GET/api/partner/v2/webhook/deliveries

Histórico das entregas do webhook, da mais recente para a mais antiga, com a resposta do seu servidor.

Parâmetros de consulta

Campo	Tipo	Descrição
`status` opcional	string	Filtra por situação. `pendingdeliveredfailed`
`limit` opcional	integer	Itens por página.
`cursor` opcional	string	nextCursor da página anterior.

statusstringopcional
Filtra por situação.
pendingdeliveredfailed
limitintegeropcional
Itens por página.
cursorstringopcional
nextCursor da página anterior.

Respostas

200Página de entregas

Campos da resposta (13)

Campo	Tipo	Descrição
`data`	object[]
`data[].id`	string	Mesmo valor do cabeçalho X-Webhook-Id.
`data[].event`	string	`movement.createdpublication.createdmonitoring.createdmonitoring.deletedmonitoring.pausedping`
`data[].status`	string	`pendingdeliveredfailed`
`data[].attempts`	integer
`data[].lastStatusCode`	integer \| null
`data[].lastError`	string \| null
`data[].lastAttemptAt`	string \| null
`data[].nextAttemptAt`	string \| null
`data[].deliveredAt`	string \| null
`data[].createdAt`	string
`data[].data`	object	Conteúdo do evento (o mesmo enviado em data no POST).
`nextCursor`	string \| null

dataobject[]
data[].idstring
Mesmo valor do cabeçalho X-Webhook-Id.
data[].eventstring
movement.createdpublication.createdmonitoring.createdmonitoring.deletedmonitoring.pausedping
data[].statusstring
pendingdeliveredfailed
data[].attemptsinteger
data[].lastStatusCodeinteger | null
data[].lastErrorstring | null
data[].lastAttemptAtstring | null
data[].nextAttemptAtstring | null
data[].deliveredAtstring | null
data[].createdAtstring
data[].dataobject
Conteúdo do evento (o mesmo enviado em data no POST).
nextCursorstring | null

Requisição

curl -X GET "https://consultadeprocessos.com.br/api/partner/v2/webhook/deliveries" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Passo 7

Reenviar entrega

POST/api/partner/v2/webhook/deliveries/{id}/retry

Coloca a entrega de volta na fila. O envio acontece em até 5 minutos.

Parâmetros do caminho

Campo	Tipo	Descrição
`id` obrigatório	string	id da entrega.

idstringobrigatório
id da entrega.

Respostas

200Entrega reagendada
404Entrega não encontrada

Requisição

curl -X POST "https://consultadeprocessos.com.br/api/partner/v2/webhook/deliveries/1842/retry" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{"document":"12345678901"}'

Passo 8

Remover webhook

DELETE/api/partner/v2/webhook

Remove o webhook e o histórico de entregas.

Respostas

200Webhook removido
404Nenhum webhook configurado

Requisição

curl -X DELETE "https://consultadeprocessos.com.br/api/partner/v2/webhook" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Próximos passos

Autenticação

Gere a chave e envie no cabeçalho.

Erros e códigos

Como tratar cada resposta de erro.

Cobrança e reembolso

Quando cobramos e quando o valor volta.

Monitoramento de processos

Acompanhe processos pelo número CNJ e receba cada movimentação ou publicação nova, sem consultar de novo.