Pular para o conteúdo principal
POST
Add webhook to store

➕ Adicionar Webhook à Loja

Este endpoint permite adicionar uma nova URL de webhook à loja, respeitando o limite máximo permitido pelo plano.

🔐 Autenticação

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

📥 Parâmetros de Rota

📥 Body da Requisição

📋 Exemplo de Requisição

📊 Exemplo de Resposta (200)

Atualizar eventos (PUT / PATCH): Você também pode enviar PUT ou PATCH /v1/stores/{storeId}/webhooks com { "url": "...", "events": [...] } (ao menos 1 evento válido obrigatório) para atualizar os eventos de um webhook existente; em caso de sucesso, retorna 200 com code: "WEBHOOK_UPDATED", "webhook" e "events" (ou 404 WEBHOOK_NOT_FOUND se a URL não estiver cadastrada).

❌ 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 optional event subscriptions.

url
string<uri>
obrigatório
Required string length: 9 - 200
events
enum<string>[]
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

Resposta

Webhook added.

code
string
obrigatório
Exemplo:

"WEBHOOK_ADDED"

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