POST com JSON para a URL que você cadastrou.
Cadastrar um endpoint
A API v2 não tem rota para gerenciar endpoints. Cadastre a URL e escolha os eventos no dashboard ou pela API v1:Endpoints de Webhook (v1)
Crie, liste, atualize e remova os endpoints que recebem as notificações.
Formato v1 ou v2
O formato do webhook depende de onde o recurso foi criado, não de uma configuração do endpoint:
O mesmo endpoint pode receber os dois formatos. Use o campo
webhook_version para decidir como ler o payload.
Eventos que não existem no formato v2 são entregues no formato v1, mesmo para recursos criados pela v2. É o caso de
charge.challenged e dos eventos de cartão (card.*).Envelope
O que vem em data
Eventos disponíveis
Pedidos
order.paid, order.failed, order.refunded, order.chargebackCobranças
charge.*Assinaturas
subscription.*Faturas
invoice.*Boas práticas
- Responda com HTTP
2xxassim que receber a notificação. Respostas fora da faixa2xxsão reenviadas, até o limite de tentativas do endpoint. - Processe a notificação de forma assíncrona na sua aplicação, depois de responder.
- Guarde o
idda entrega e ignore repetições. - Não dependa da ordem de chegada dos eventos. Na dúvida, consulte o recurso pela API.
A verificação por código (OTP) não gera webhook. Ela aparece apenas no
next_action da resposta do pedido ou da fatura.