Skip to main content
Este endpoint permite crear un widget en Jelou, ya sea asociándolo a un bot existente o creando un bot nuevo junto con el widget.
Los widgets definen la experiencia visual y de entrada para los usuarios finales (por ejemplo, en Web Chat).

​
Crear un widget

​
Endpoint

POST https://api.jelou.ai/v1/widget/create

​
Cabeceras

​
Content-Type
string
required
Tipo de contenido de la solicitud. Debe ser application/json.
​
Authorization
string
required
Token de autenticación en formato Basic <TOKEN_COMPANY>.

​
Cuerpo de la solicitud

​
bot
object
required
Información del bot a asociar al widget.
Puede incluir un id para usar un bot existente o enviarse vacío para crear uno nuevo.
​
widget
object
required
Configuración visual y funcional del widget.
​
credentials.blackList
array
Lista de credenciales bloqueadas para el widget.
​
credentials.whiteList
array
Lista de credenciales permitidas para el widget.

​
\

Respuestas
  • 200 – OK: Widget creado exitosamente.
  • 401 – Unauthorized: Credenciales inválidas o faltantes.
  • 500 – Internal Server Error: Error interno del servidor.

​
Ejemplo de respuesta

{
  "message": ["Widget was created successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "Bot": "<Bot_Payload>",
    "Widget": "<Widget_Payload>",
    "ApiKey": {
      "id": 123,
      "state": 1,
      "key": "<apikey>",
      "widgetId": "<widgetId>",
      "updatedAt": "<Date>",
      "createdAt": "<Date>"
    }
  }
}

​
Crear widget con bot existente

​
Ejemplo de solicitud

cURL
curl --request POST \
  --url https://api.jelou.ai/v1/widget/create \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic <TOKEN_COMPANY>' \
  --data '{
    "bot": {
      "id": "<botId>"
    },
    "widget": {
      "properties": {
        "type": "group"
      },
      "theme": {
        "position": "br",
        "status": true,
        "font": {
          "googlefont": true,
          "name": "Manrope"
        }
      }
    }
  }'

​
Crear bot y widget

​
Ejemplo de solicitud

cURL
curl --request POST \
  --url https://api.jelou.ai/v1/widget/create \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic <TOKEN_COMPANY>' \
  --data '{
    "bot": {},
    "widget": {
      "properties": {
        "type": "normal"
      },
      "theme": {
        "position": "br",
        "font": {
          "googlefont": true,
          "name": "Manrope"
        }
      }
    }
  }'
La configuración del widget puede ser extendida con propiedades visuales avanzadas como colores, tipografía, menús y paneles.
Consulta la documentación de personalización de widgets para más detalles.