Documentación técnica: todas las rutas, permisos y ejemplos actuales de la API están en docs.fitsociety.io. Si eres desarrollador, empieza por la guía de inicio rápido de Public API.
Un webhook envía un aviso a otro sistema cuando ocurre algo en FITsociety. Así, tu CRM puede reaccionar a un nuevo miembro o tu automatización puede empezar tras una nueva reserva.
En este artículo
¿Qué necesitas?
Necesitas acceso a Public API y a la gestión de webhooks de tu empresa, además de una dirección receptora de tu desarrollador o de tu herramienta de automatización. Debe ser una dirección HTTPS accesible públicamente. Una dirección localhost o una dirección de red interna no funciona.
El webhook informa de un evento; el otro sistema realiza el siguiente paso. Para obtener datos adicionales o hacer un cambio en FITsociety, además puede hacer falta un cliente de API con los permisos adecuados.
Crea el webhook
En la empresa correcta, ve a Configuración → Plugins e integraciones → Webhooks.
Elige Añadir webhook e introduce un nombre reconocible.
En Target URL, introduce la dirección receptora.
Revisa Events y selecciona solo los eventos que necesitas, como
client.createdobooking.created. Comprueba también la selección inicial.Guarda el webhook y copia el secreto de firma que se muestra una sola vez. Pide a tu desarrollador que lo guarde de forma segura y compruebe la firma de los avisos.
Prueba y revisa las entregas
Usa la acción de prueba del webhook y comprueba que el sistema receptor procese el aviso. Revisa también los intentos de entrega recientes en FITsociety. Una entrega correcta tiene el estado delivered: el receptor respondió con HTTP 2xx.
Si hay un error, se realizan como máximo tres intentos de entrega en total. failed todavía puede recibir un nuevo intento; exhausted significa que no quedan intentos. Ante errores, pide que se revisen la dirección receptora, la disponibilidad y el mensaje de error.
Una prueba correcta demuestra que la recepción funciona. Comprueba además un evento real y la acción posterior deseada antes de confiar en el proceso.
Modificar y procesar los avisos con cuidado
Al editar el webhook puedes cambiar la dirección, los eventos o el estado. Ponlo en Desactivado para detener nuevos avisos a través de este webhook. Revisa también en el otro sistema las acciones ya recibidas o en curso.
Los avisos contienen datos resumidos, no una ficha completa del cliente. Haz que el receptor reconozca los avisos duplicados mediante el ID estable del evento, para que el mismo evento no inicie dos veces una acción.
Para gestionar webhooks por API existen webhooks:read, webhooks:write y, para los intentos de entrega, webhook_deliveries:read. La documentación técnica describe los eventos, los payloads y la verificación de firmas.
Más información
Documentación técnica para tu desarrollador (en inglés)