Generar y usar API keys y webhooks
Crea claves de API para acceder a Omnifox por código y configura webhooks para recibir eventos en tiempo real.
Mira este paso en el video · Crear una clave API
Si quieres conectar Omnifox con sistemas propios o automatizar acciones, la API REST y los webhooks son tus mejores aliados. Las API keys autentican tus llamadas a la API; los webhooks te avisan al instante cuando ocurre algo en tu workspace. Aquí aprenderás a generar y usar ambos.
Generar una API key
- Abre API Keys en el menú lateral.
- Pulsa Nueva clave API.
- Ponle un nombre descriptivo (por ejemplo, "Integración tienda online").
- Selecciona los permisos (alcances) que necesita: contactos, conversaciones, mensajes, etc.
- Pulsa Generar. Copia la clave de inmediato: por seguridad solo se muestra una vez.
Guarda la clave en un lugar seguro (un gestor de secretos). Si la pierdes, revócala y crea una nueva.
Usar tu API key
Incluye la clave en la cabecera Authorization de cada petición:
Authorization: Bearer TU_API_KEY- La API REST V1 vive en
/api/v1/*(por ejemplo,https://omnifox.io/api/v1/contacts). - Respeta los límites de uso (rate limits); si recibes un
429, espera y reintenta.
Configurar un webhook
- Abre Webhooks en el menú lateral.
- Pulsa Nuevo webhook.
- Pega la URL de destino (un endpoint público en tu servidor que reciba POST).
- Marca los eventos que quieres recibir: mensaje entrante, conversación creada, contacto actualizado, etc.
- Guarda. Omnifox enviará un POST con un cuerpo JSON cada vez que ocurra el evento.
Verificar y asegurar tus webhooks
- Cada envío incluye una firma en las cabeceras; valídala con tu secreto de webhook para confirmar que el evento es legítimo.
- Responde con un
200rápidamente. Si tu endpoint falla o tarda, Omnifox reintentará con backoff. - Usa HTTPS siempre.
Buenas prácticas
- Crea una API key por integración, así puedes revocar una sin afectar las demás.
- Concede solo los permisos mínimos necesarios.
- Registra (logs) cada webhook recibido para depurar más fácil.
Consejo: prueba tus webhooks con una herramienta como un endpoint de inspección antes de apuntarlos a producción. Verás el formato exacto del JSON y evitarás sorpresas.
Artículos relacionados
-
Cómo conectar integraciones y apps externas
Conecta Omnifox con tus herramientas favoritas desde el catálogo de integraciones en pocos pasos.
-
Guía completa de integraciones y API
Integraciones y API a fondo, en 30 capítulos: claves API, llamadas reales, webhooks firmados, n8n, MCP y SDK, todo funcionando de verdad.
-
Integrar Omnifox con Azur, Siigo, Alegra, QuickBooks u otro sistema contable o ERP
Omnifox no tiene hoy un conector nativo con sistemas contables o ERP. Te explicamos cómo conectarlos igual con workflows, el nodo HTTP, n8n, Make, Zapier o la API, con ejemplos.
-
Introducción a las integraciones (webhook / OAuth / API key)
Conecta Omnifox con tus otras herramientas: qué está disponible hoy, qué llega pronto y cuándo usar un webhook, una conexión OAuth o una clave de API.
-
La API REST de Omnifox: introducción y requisitos de plan
Qué es la API REST de Omnifox, qué plan necesitas (desde Crece), cómo autenticar con la cabecera X-API-Key y dónde está la documentación.