Suscripciones

Al envíar mensajes masivos utilizando plantillas, se pueden generar notificaciones para que puedas suscribirte a esa información relevante y tu equipo pueda gestionar los datos de cada mensaje mediante webhooks.

Un webhook es un método para que un sistema notifique a otro sistema o aplicación sobre eventos o actualizaciones en tiempo real. Primero, debes verificar si ya hay suscripciones configuradas en tu bot para evitar duplicarlas. Luego, podrás suscribirte a los eventos que necesites.

Eventos Permitidos

• delivered_channel: La plantilla fue enviada a través de WhatsApp.
• delivered_user: La plantilla fue enviada al usuario.
• failed: La entrega de la plantilla falló.
• read: El usuario leyó la plantilla. Este evento solo se recibirá si el usuario tiene activados los check azules en WhatsApp.
• reply: El usuario respondió a la plantilla.

Obtener Suscripciones

GET https://api.jelou.ai/v1/bots/:botId/events/webhook

Este endpoint te permite obtener la información de las suscripciones anteriores.

Parámetros de la Ruta

Propiedad	Tipo de dato	Descripción	Requerido
botId	string	ID del Bot	Sí

Parámetros de los Encabezados

Propiedad	Tipo de dato	Descripción	Requerido
Authentication	string	Token de autenticación	Sí

Ejemplo

{
  "request": "GET",
  "url": "https://api.jelou.ai/v1/bots/BOT_ID/events/webhook",
  "headers": {
    "Authorization": "Basic {{Base64EncodedUsername:Password}}"
  }
}

Suscribirse a Eventos

Este endpoint te permite suscribirte a tu webhook. POST https://api.jelou.ai/v1/bots/:botId/events/webhook

Parámetros de la Ruta

Propiedad	Tipo de dato	Descripción	Requerido
botId	string	ID del Bot	Sí

Parámetros del Cuerpo

Propiedad	Tipo de dato	Descripción	Requerido
webhooks	array	Array de objetos webhook, cada uno contiene una URL y los eventos a los que se suscribe.	Sí
url	string	URL del webhook.	Sí
events	array	Lista de Tipo de datos de evento a los que el webhook se suscribirá (delivered_channel, delivered_user, failed, read, reply).	Sí

Parámetros de los Encabezados

Propiedad	Tipo de dato	Descripción	Requerido
Authentication	string	Token de autenticación.	Sí

ejemplo

 "cURL": "curl --request POST \\ \n  --url 'https://api.jelou.ai/v1/bots/BOT_ID/events/webhook' \\ \n  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \\ \n  --header 'Content-Type: application/json' \\ \n  --data '{\n  \"webhooks\": [\n    {\n      \"url\": \"https://webhook.site/0e09fd45\",\n      \"events\": [\n        \"delivered_user\",\n        \"delivered_channel\",\n        \"failed\"\n      ]\n    },\n    {\n      \"url\": \"https://webhook.site/22222\",\n      \"events\": [\n        \"reply\",\n        \"read\"\n      ]\n    }\n  ]\n}'"
},
"response": {
 "200": {
   "message": [
     "Webhooks created succesfully!"
   ],
   "statusMessage": "success",
   "status": 1,
   "data": [
     {
       "url": "https://webhook.site/0e09fd45",
       "events": [
         "delivered_user",
         "delivered_channel",
         "failed"
       ]
     },
     {
       "url": "https://webhook.site/22222",
       "events": [
         "reply",
         "read"
       ]
     }
   ]
 }
}
}