Documentación Técnica y SDK

Widget JS•Shadow DOM•Eventos Cliente•Webhooks

Guía de referencia para la integración del widget web, configuración del SDK cliente, suscripción a webhooks y consumo de la API de Firby AI.

01. Instalación del widget web

Para activar Firby en cualquier sitio web, inserte la siguiente etiqueta de script antes del cierre de </body> en su plantilla HTML:

<!-- Firby Web Operator SDK -->
<script src="https://firbyai.com/widget.js" data-tenant="TU_TENANT_ID" async defer></script>

El script inicializa un componente Shadow DOM totalmente encapsulado, previniendo cualquier contaminación de estilos con su sitio web principal.

02. Parámetros de inicialización

Puede personalizar el comportamiento inicial mediante atributos data-* en la etiqueta del script:

data-tenant (Obligatorio)

Identificador único de su empresa o consultorio en Firby AI.

data-lang (Opcional)

Idioma inicial de atención. Valores admitidos: es (Español) o en (English). Por defecto detecta el idioma del navegador.

data-theme (Opcional)

Esquema de color preferente: dark, light o auto.

03. Eventos en el navegador (JavaScript Client API)

Firby emite eventos nativos del DOM que permiten a su equipo técnico coordinar analíticas o activar acciones personalizadas en su frontend:

// Escuchar cuando una cita queda confirmada
window.addEventListener('firby:booking_confirmed', function(event) {
  console.log('Cita confirmada:', event.detail.bookingId);
  console.log('Servicio:', event.detail.serviceName);
  console.log('Fecha:', event.detail.scheduledAt);
});

04. Webhooks de servidor

Configure un endpoint HTTPS en su panel de control para recibir notificaciones inmediatas ante eventos clave:

{
  "event": "lead.qualified",
  "timestamp": "2026-10-22T21:30:00Z",
  "data": {
    "lead_id": "lead_9281a7",
    "name": "Carlos Mendoza",
    "contact": "+57 300 123 4567",
    "service_interest": "Valoración Especializada"
  }
}

¿Tiene dudas de integración?

Nuestro equipo de arquitectura está disponible para asistir a su equipo de desarrollo en la configuración de flujos avanzados.

Contactar a ingeniería