Webhooks

Cadastro, recebimento, processamento e reconciliação de webhooks.

Webhooks enviam atualizações ao endpoint cadastrado pela integração. Essas notificações complementam as consultas à API para acompanhar o estado dos recursos.

flowchart LR
  C[Cadastro] --> R[Recebimento]
  R --> P[Processamento]
  P --> X[Reconciliação]
  X -->|falha de entrega| E[Reenvio]

Fluxo recomendado

  1. Cadastre a URL e, quando necessário, headers adicionais.
  2. Receba o evento e responda sem bloquear em processamento demorado.
  3. Trate o evento de forma idempotente.
  4. Quando houver dúvida, consulte o recurso atual pela API.
  5. Use a operação de reenvio de webhook de Venda quando aplicável.

Webhooks de Vendedor possuem endpoints próprios e devem ser configurados separadamente.

Veja também