Webhook
Un Webhook es una notificación de eventos por medio de HTTP POST. Cuando algo sucede en la tienda, por ejemplo, se ha creado un nuevo producto, el sistema notifica a tu servidor por medio de una petición HTTP con método POST (Webhook).
Con la API de Webhooks puedes indicar en qué URI recibirás la notificación y cuándo quieres recibirla.
Puede registrar webhooks para los siguientes eventos:
- Product: creado/borrado/actualizado
- Collection: creada/borrada/actualizada
- Shop: actualizada
- Page/Blog/Article: creado/borrado
Acciones disponibles
GET
/admin/webhooks.json
Obtener una lista de todos los webhooks registrados en la tienda.
GET
/admin/webhooks/count.json
Consultar el número de webhooks registrados en la tienda.
GET
/admin/webhooks/:id.json
Obtener las propiedades del webhook :id registrado.
POST
/admin/webhooks.json
Crear un nuevo webhook.
PUT
/admin/webhooks/:id.json
Modificar un webhook.
DELETE
/admin/webhooks/:id.json
Eliminar un webhook.
Propiedades de un webhook
| Propiedad | Descripción | Ejemplo |
|---|---|---|
| uri | La URI a donde se envía la petición POST cuando ocurre el evento. | { "uri" : "https://myapplication.com/product-created" } |
| topic | El evento que hace que se envíe la petición. | { "topic" : "products/create" } |