Skip to main content
PUT
Substituir webhook
Requer o escopo webhooks:create e o header HTTP Idempotency-Key. Substitui o destino, o conjunto de eventos e o escopo de produto. Um token ausente mantém o que está gravado.
active não é lido aqui. Enviar o campo não dá erro e não muda nada: silenciar ou religar uma assinatura é o que o toggle faz, justamente para que uma edição de rotina não derrube as entregas por acidente.A API antiga aceitava active neste endpoint.
Uma assinatura de outra conta retorna 404 sem escrever nada.

Authorizations

Authorization
string
header
required

A chave de API da conta, no formato sk_{modo}_{prefixo}.{segredo}.

Headers

Idempotency-Key
string
required

Chave única da operação. Obrigatória em toda requisição que altera dados; sem ela a resposta é 422 idempotency_key_required. Um reenvio com a mesma chave e o mesmo corpo repete a resposta guardada.

Maximum string length: 255

Path Parameters

id
integer
required

Body

application/json

Body of PUT /v2/public/webhooks/{id}. A replace of the reconfigurable set: destination, event set and product scope all take the submitted value.

It does not accept active, although the source api did. Muting a subscription is what the toggle endpoint is for, so a routine edit cannot silence deliveries as a side effect; the panel's own update follows the same rule. A caller sending it gets no error and no change.

url
string<uri>
required
Maximum string length: 2048
token
string | null
Maximum string length: 255
product_id
integer | null
order_payment_approved
boolean
order_payment_pending
boolean
order_payment_failed
boolean
order_payment_refunded
boolean
order_subscription_approved
boolean
order_subscription_pending
boolean
order_subscription_failed
boolean
order_subscription_refunded
boolean
order_subscription_canceled
boolean
order_subscription_trial_started
boolean

Response

ApiWebhookResource

data
ApiWebhookResource · object
required