Atualizar webhook
Webhooks
Atualizar webhook
Muda nome, URL e a lista de eventos assinados de um webhook já cadastrado.
PATCH
Atualizar webhook
PATCH /webhooks/:id
Faz parte do recurso Webhooks — o cadastro e o catálogo de eventos estão lá.
Atualiza o que já está cadastrado. Todos os campos são opcionais: envie só o que muda, o resto
permanece.
O
secret não se troca aqui, nem em nenhuma outra rota. O campo não é aceito no corpo, e não
existe endpoint de rotação — a troca é feita no painel. Pela API, o equivalente é
criar um webhook novo com o mesmo destino e
remover o antigo.Trocar a URL não reenvia o que já falhou. As entregas anteriores guardam o endereço para o
qual saíram; o novo vale das próximas em diante. Para recuperar o que se perdeu, use
Reprocessar entrega — ela sai para a URL atual.
Exemplo
Resposta 200
Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID do webhook
Body
application/json
Required string length:
1 - 255Available options:
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 Response
Webhook atualizado
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).