Pular para o conteúdo principal
PUT
Update webhook events

🔄 Atualizar Webhook da Loja

Este endpoint permite atualizar os eventos inscritos (events) de um webhook já cadastrado na loja, utilizando PUT ou PATCH com a mesma estrutura de corpo.

🔐 Autenticação

Esta rota exige autenticação via API Key, enviada no header da requisição:

📥 Parâmetros de Rota

📦 Corpo da Requisição

📋 Exemplo de Requisição

Também é possível usar PATCH na mesma rota (/v1/stores/{storeId}/webhooks) com o mesmo corpo.

📊 Exemplo de Resposta (200)

❌ Possíveis Erros

Autorizações

Authorization
string
header
padrão:YOUR_API_KEY_HERE
obrigatório

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50

Corpo

application/json

Webhook URL and updated event subscriptions.

events
enum<string>[]
obrigatório
Minimum array length: 1
Opções disponíveis:
store.created,
store.updated,
store.deleted,
store.reordered,
product.created,
product.updated,
product.deleted,
product.reordered,
category.created,
category.updated,
category.deleted,
category.reordered,
coupon.created,
coupon.updated,
coupon.deleted,
coupon.reordered,
page.upserted,
page.deleted,
affiliate.created,
affiliate.updated,
affiliate.deleted,
payment.created,
payment.updated,
payment.deleted,
payment.status.changed
url
string<uri>
obrigatório
Required string length: 9 - 200

Resposta

Webhook updated.

code
string
obrigatório
Exemplo:

"WEBHOOK_UPDATED"

events
enum<string>[]
obrigatório
Opções disponíveis:
store.created,
store.updated,
store.deleted,
store.reordered,
product.created,
product.updated,
product.deleted,
product.reordered,
category.created,
category.updated,
category.deleted,
category.reordered,
coupon.created,
coupon.updated,
coupon.deleted,
coupon.reordered,
page.upserted,
page.deleted,
affiliate.created,
affiliate.updated,
affiliate.deleted,
payment.created,
payment.updated,
payment.deleted,
payment.status.changed
webhook
string<uri>
obrigatório