Saltar al contenido principal
POST
Add webhook to store

➕ Agregar Webhook a la Tienda

Este endpoint permite agregar una nueva URL de webhook a la tienda, respetando el límite máximo permitido por el plan.

🔐 Autenticación

Esta ruta requiere autenticación mediante API Key, enviada en el header de la solicitud:

📥 Parámetros de Ruta

📥 Body de la Solicitud

📋 Ejemplo de Solicitud

📊 Ejemplo de Respuesta (200)

Actualizar eventos (PUT / PATCH): También puedes enviar PUT o PATCH /v1/stores/{storeId}/webhooks con { "url": "...", "events": [...] } (al menos 1 evento válido obligatorio) para actualizar los eventos de un webhook existente; en caso de éxito, retorna 200 con code: "WEBHOOK_UPDATED", "webhook" y "events" (o 404 WEBHOOK_NOT_FOUND si la URL no está registrada).

❌ Posibles Errores

Autorizaciones

Authorization
string
header
predeterminado:YOUR_API_KEY_HERE
requerido

Parámetros de ruta

storeId
string
requerido
Required string length: 1 - 50

Cuerpo

application/json

Webhook URL and optional event subscriptions.

url
string<uri>
requerido
Required string length: 9 - 200
events
enum<string>[]
Opciones disponibles:
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

Respuesta

Webhook added.

code
string
requerido
Ejemplo:

"WEBHOOK_ADDED"

events
enum<string>[]
requerido
Opciones disponibles:
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>
requerido