Skip to main content
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.
events substitui a lista inteira — e [] assina TUDO. Não há como acrescentar ou remover um evento isoladamente: mande a lista final que você quer. E cuidado com o vazio, que é curinga, não “nenhum”: events: [] faz o webhook receber todos os eventos existentes e futuros. Para parar de receber, desative o webhook.
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

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do webhook

Body

application/json
name
string
Required string length: 1 - 255
url
string<uri>
events
enum<string>[]
Available 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

id
string
required

Identificador único do registro.

name
string
required

Nome do registro.

url
string<uri>
required

URL de destino do webhook ou link de download do arquivo.

events
string[]
required

Tipos de evento assinados pelo webhook.

isActive
boolean
required

Indica se o registro está ativo.

hasSecret
boolean
required
secretHint
string | null
required
autoDisabledAt
string<date-time> | null
required
createdAt
string<date-time>
required

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>
required

Data e hora da última atualização do registro (ISO 8601).