Funcionamiento general
Recibe mensajes automáticos cada que ocurra un evento en tu tienda de Yuju.
Puedes agregar hasta 3 configuraciones de webhooks con las suscripciones que necesites. Cada suscripción debe contar con las siguientes características:
- Se debe definir una URL https con certificado de seguridad (ssl) válido. Valida tu certificado aquí.
- Cuando recibas un mensaje del webhook, es necesario que respondas con un código de estado exitoso (200, 201, 204).
- El tiempo de respuesta no puede ser mayor a 500 ms.
Te puedes suscribir a uno o más topics en una misma configuración, los topics son:
| Nombre | Descripción |
|---|---|
| category-datasheet | Indica la tarea de generación de reporte de ficha técnica por categoría fue finalizada (mira más aquí) |
| products-datasheet | Indica la tarea de generación de reporte de ficha técnica por productos fue finalizada (mira más aquí) |
| products-offer | Indica que la tarea de actualización masiva de oferta fue finalizada (mira más aquí) |
| categorizer | Indica que el categorizador de productos ha finalizado (mira más aquí). |
| new-order | Indica la creación de una nueva orden. |
| updated-order | Indica una actualización en una orden existente. |
| new-std-order | Indica la creación de una nueva orden con formato estándar. (mira mas aqui) |
| updated-std-order | Indica una actualización en una orden con formato estándar existente. |
| std-orders-report | Indica cuando la generación de un reporte de pedidos |
Cada webhook tendrá hasta 3 intentos extras si llega a fallar.
- A los 5 minutos después del primer intento.
- A los 10 minutos después del intento anterior.
- A los 15 minutos después del intento anterior.
Cómo recibir un webhook:
Lo primero que debe realizar es la suscripción a un topic, puede consultar aquí cómo hacerlo, una vez realizada la suscripción Yuju usará el endpoint configurado para hacer un request con las siguientes cabeceras:
| Header | Descripción |
|---|---|
| x-yuju-id | Identificador del evento |
| x-yuju-topic | Topic del evento |
| x-yuju-resource | Id del recurso |
| x-yuju-id-account | Id cuenta yuju |
| x-yuju-id-shop | Id tienda yuju |
| x-yuju-id-channel | Id del canal |
| x-yuju-attempts | Número de intentos |
| x-yuju-received | Momento en que se generó el evento |
| x-yuju-send | Momento en que se envió el evento a la app |
Ejemplo cebeceras de la respuesta :
POST https\://example_cliente.xyz/example-webhook HTTP/1.1
x-yuju-id: ab23kjbh234234bhj
x-yuju-topic: category-datasheet
x-yuju-resource: 676254231
x-yuju-id-account: 1
x-yuju-id-shop: 307
x-yuju-id-channel: 4301
x-yuju-attempts: 1
x-yuju-received: 2022-11-03T01:31:34.946066
x-yuju-send: 2022-11-03T01:32:34.946066
Mira este video tutorial para suscribirte a los webhooks.
Updated 4 months ago