Criar webhook
Registra um endereço para receber notificações e devolve o secret de assinatura — a única vez que ele aparece.
POST /webhooks
Faz parte do recurso Webhooks — o catálogo de eventos e as regras do secret
estão lá.
Registra a URL, define quais eventos ela recebe e devolve 201 com o webhook criado. Já nasce
ativo: se houver evento assinado acontecendo, a primeira entrega sai em seguida.
whsec_… de 256 bits,
que volta nesta mesma resposta — mais forte que a maioria dos valores escolhidos à mão. Enviar o
seu próprio continua valendo, com no mínimo 8 caracteres, para quando o segredo já existe do seu
lado.events vazio, ou omitido, assina TODOS os eventos — inclusive os que forem criados no
futuro. Para receber só o que interessa, liste os códigos do
catálogo; um código fora dele é recusado com 400.localhost, faixas privadas e endereços de metadata de nuvem são
recusados com 400 — a lista completa está na visão geral.Exemplo
Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Body
Nome de identificação do webhook.
1 - 255URL HTTPS que receberá as notificações de eventos (via POST).
Eventos que disparam notificações para este webhook (ex.: transaction.paid, payment.refunded).
transaction.created, transaction.waiting_payment, transaction.paid, transaction.partially_paid, transaction.pending, transaction.refused, transaction.failed, transaction.canceled, transaction.waiting_refund, transaction.refunded, transaction.in_protest, transaction.chargeback, payment.created, payment.waiting_payment, payment.paid, payment.pending, payment.refused, payment.failed, payment.canceled, payment.waiting_refund, payment.refunded, payment.in_protest, payment.chargeback, refund.created, refund.approved, refund.refused, refund.processing, refund.refunded, refund.failed, refund.awaiting_bank_details, refund.bank_details_received, refund.invalid_bank_details, refund.ted_processing, chargeback.opened, chargeback.under_review, chargeback.submitted, chargeback.won, chargeback.lost, chargeback.document.uploaded, customer.created, customer.updated, recipient.created, recipient.updated, recipient.approved, recipient.refused, recipient.deleted, recipient.pendency_updated, withdrawal.requested, withdrawal.paid, withdrawal.rejected, invoice.issued, invoice.payment_attempted, invoice.paid, invoice.voided, invoice.refunded, invoice.rescheduled, subscription.created, subscription.trial_started, subscription.activated, subscription.canceled, subscription.cycle_advanced, subscription.paused, subscription.resumed, subscription.past_due, subscription.unpaid, subscription.restored, subscription.reactivated, anticipation.status_changed Segredo usado para assinar (HMAC) os payloads e validar a autenticidade das notificações.
8Response
Webhook criado
Identificador único do registro.
Nome do registro.
URL de destino do webhook ou link de download do arquivo.
Tipos de evento assinados pelo webhook.
Indica se o registro está ativo.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
Segredo usado para assinar as entregas do webhook.