Skip to main content
PATCH
Atualizar webhook

Authorizations

Authorization
string
header
required

API Key no formato cvx_live_..., criada no painel Corvex. Não use JWT de sessão nem x-api-key.

Headers

X-Store-Id
string<uuid>
required

UUID da loja. A chave precisa ter esta loja autorizada.

Path Parameters

webhookId
string<uuid>
required

UUID do webhook.

Body

application/json
name
string
Required string length: 1 - 100
description
string
Maximum string length: 500
url
string<uri>

URL HTTPS que recebe o POST.

Maximum string length: 500
events
enum<string>[]

Eventos que disparam o webhook.

Required array length: 1 - 20 elements
Available options:
ORDER_CREATED,
ORDER_PAID,
ORDER_REFUNDED,
ORDER_CANCELLED,
ORDER_COMPLETED,
SUBSCRIPTION_CREATED,
SUBSCRIPTION_CANCELLED,
SUBSCRIPTION_RENEWED,
CUSTOMER_CREATED,
CUSTOMER_UPDATED,
PRODUCT_CREATED,
PRODUCT_UPDATED,
PRODUCT_DELETED,
CHECKOUT_CREATED,
CHECKOUT_UPDATED,
CART_ABANDONED,
PAYMENT_PROCESSED,
PAYMENT_FAILED,
MEMBER_AREA_ACCESS_GRANTED,
MEMBER_AREA_ACCESS_REVOKED
secret
string

Opcional. Nunca volta nas respostas; use hasSecret.

Maximum string length: 100
active
boolean
retryAttempts
integer

Padrão 3.

Required range: 0 <= x <= 10
timeout
integer

Timeout em segundos. Padrão 30.

Required range: 5 <= x <= 300
headers
object | null

Headers extras no POST. null para limpar.

Response

Sucesso.