Visão geral

Webhooks

Os webhooks do Jurídico Certo seguem um fluxo simples:

  1. o cadastro do endpoint é feito no jobs-contractor-api
  2. os sistemas de negócio publicam o evento na fila interna
  3. o jobs-robots consome a fila e faz o POST HTTP para a URL cadastrada

Importante:

  • A URL do webhook deve usar HTTPS.
  • A URL deve apontar para um host público.
  • URLs com localhost, IP privado ou host não público são rejeitadas no cadastro.
  • O campo autorizacao é opcional e, quando informado, é enviado no header Authorization.
  • Apenas usuários autenticados com permissão administrativa da conta conseguem gerenciar webhooks.

Endpoints de cadastro

A categoria Webhooks possui uma subpágina para cada endpoint de cadastro:

  • POST /v1/webhooks
  • GET /v1/webhooks
  • GET /v1/webhooks/{evento}
  • DELETE /v1/webhooks/{evento}

Eventos suportados

O body enviado para a sua URL sempre inclui o campo event, com o mesmo nome do evento cadastrado no webhook, além do payload específico do evento abaixo.

Observação:

  • O publisher listado abaixo é o repositório que publica o evento na fila interna.
  • O disparo HTTP para a URL cadastrada é sempre feito pelo jobs-robots.
  • proposta.recebida e proposta.contratada usam link no formato /propostas/<id_demanda>/<id_proposta>.
  • proposta.alteracao_valor_solicitado e reembolso.solicitado usam link no formato /propostas/<id_demanda>.

demanda.criada

Publisher: jobs-manager

{
  "event": "demanda.criada",
  "id_demanda": 2455650
}

demanda.cancelada

Publisher: jobs-manager, jobs-robots

{
  "event": "demanda.cancelada",
  "id_demanda": 2455651
}

demanda.finalizada

Publisher: jobs-manager, jobs-robots

{
  "event": "demanda.finalizada",
  "id_demanda": 2455650
}

proposta.recebida

Publisher: jobs-professional-api

{
  "event": "proposta.recebida",
  "id_proposta": 11058632,
  "id_demanda": 2455640,
  "link": "https://demandas.juridicocerto.com/propostas/2455640/11058632"
}

proposta.alteracao_valor_solicitado

Publisher: jobs-professional-api

{
  "event": "proposta.alteracao_valor_solicitado",
  "id_proposta": 11058623,
  "id_demanda": 2455624,
  "link": "https://demandas.juridicocerto.com/propostas/2455624"
}

proposta.contratada

Publisher: jobs-manager

{
  "event": "proposta.contratada",
  "id_proposta": 11058588,
  "id_demanda": 2455486,
  "link": "https://demandas.juridicocerto.com/propostas/2455486/11058588"
}

mensagem.recebida

Publisher: jobs-chat

{
  "event": "mensagem.recebida",
  "id_proposta": 5,
  "id_demanda": 550001,
  "link": "https://demandas.juridicocerto.com/propostas/550001"
}

reembolso.solicitado

Publisher: jobs-professional-api

{
  "event": "reembolso.solicitado",
  "id_proposta": 11058623,
  "id_demanda": 2455624,
  "link": "https://demandas.juridicocerto.com/propostas/2455624"
}