Crear suscripción
Indica a donde Yuju debe enviar las notificaciones y bajo que tipo de evento enviar la notificación.
Yuju te permite crear varias configuraciones de webhooks con las cuales puedes especificar 3 eventos (topics) en una sola url a la que se enviarán las notificaciones. Esta solución es ideal si deseas controlar escenarios muy específicos para una o todas tus tiendas, gestionar los destinos de manera acorde y hacer pruebas antes de incorporar cambios en tus entornos productivos.
Endpoint:
POST https://api.tp.yuju.io/webhook-sub
Campo | Descripción | Requerido |
---|---|---|
url | Url donde se notificará | SI |
topics | Lista de topics a los que desea suscribirse | SI |
headers | Objeto json (llave, valor) que se desea agregar | NO |
Ofrecemos el campo headers para que los clientes tengan la flexibilidad de incluir autenticaciones (Basic, Bearer, entre otros), así como cualquier dato adicional que deseen enviar mediante los encabezados de manera sencilla y segura. Al especificar los headers, el seller solicita a Yuju que los incluya automáticamente en todos los webhooks que la plataforma Yuju envíe.
Ejemplo:
{
"url": "https://sha256.badssl.com//",
"topics": [
"new-order",
"updated-order"
],
"headers": {
"Authorization": "Bearer 12123",
"token": "123123"
}
}
Response:
{
"is_active": true,
"id_shop": 307,
"id_third_party_app": 7,
"url": "https://sha256.badssl.com/",
"id_third_party_app_webhook": 6,
"topics": [
"new-order",
"updated-order"
],
"headers": {
"Authorization": "Bearer 12123",
"token": "123123"
}
}
Errors Response:
Reglas de campos:
Campo | Regla |
---|---|
url | Valida url con certificado SSL |
topics | Un topic valido |
headers |
|
Response
//URL
{
"message": {
"url": ["certificado invalido"]
}
//topics
{
"message": {
"topics": ["Uno o varios valores en topics no se encuentran dentro de topics validos: category-datasheet, products-datasheet, products-offer, categorizer, new-order, updated-order, new-std-order, updated-std-order, std-orders-report, products-gral-report, product-created, product-deleted, analytics-report"]
}
// headers:
{
"message": {
"headers": ["En objeto headers, no se permiten más de 3 claves."]
}
// headers:
{
"message": {
"headers": ["En objeto headers, los valores no pueden excederlos 1000 caracteres."]
}
Updated 12 days ago