Los webhooks le permiten suscribirse a eventos que ocurren en Fluid y recibir automáticamente una entrega de datos en su servidor cada vez que ocurren esos eventos.
Cuando ocurre un evento al que su webhook está suscrito, Fluid enviará una solicitud HTTP con datos sobre el evento a la URL que usted especificó. Si su servidor está configurado para escuchar las entregas de webhooks en esa URL, puede realizar una acción cuando reciba una.
En un tablero de Fluid, los eventos se basan en las Acciones/Tarjetas que forman parte del tablero. Los eventos admitidos son Crear, Actualizar y Eliminar. Cada vez que ocurre uno de estos eventos en una Acción del tablero, se llamará a su webhook.
Acceder a la opción Integraciones en el tablero
Para comenzar, vaya a las opciones de integraciones en su tablero desde la pestaña Herramientas.
Una vez que se selecciona la opción Integraciones y se abre el diálogo, podrá seleccionar la integración para Action Webhooks.
El siguiente diálogo mostrará la página Set Up, donde se pueden completar los detalles de la integración para el tablero.
Puede obtener más información sobre cómo crear inicialmente un tablero en Fluid haciendo clic aquí.
Completar los detalles de la integración
Cada una de las secciones de los detalles de la integración es la siguiente:
|
Nombre |
Nombre amigable para esta integración que se usará como parte del encabezado de solicitud HTTP User-Agent. Tendrá el prefijo Fluid-Hookshot/{Name} |
|
Activo |
Indica si la integración está actualmente habilitada para este tablero. |
|
Webhook Url |
El endpoint de URL al que desea que Fluid envíe las solicitudes. Se requiere la URL completa, incluyendo http:// o https://, p. ej. https://your.organisation.com/events |
|
Proveedor de autenticación |
Vea a continuación en la siguiente sección. |
Proveedor de autenticación
Fluid admite Shared secret, PAT tokens o Basic Authentication para el acceso al endpoint de la URL de su webhook. Los gerentes de proyecto deben trabajar con sus equipos internos de TI para proporcionar la información que se detalla a continuación como parte de los requisitos de configuración.
NOTA: Todas las contraseñas/secretos se almacenan de forma segura y cifrados en nuestro Key Vault en la nube. Todo acceso al Key Vault está autenticado.
Shared Secret
Un shared secret es una firma que se agrega al payload del webhook y que su organización verifica en la entrega. El valor del secreto se usa para firmar el payload mediante SHA-256
Debe configurar un secreto de webhook para su webhook y verificar que la firma de cada entrega del webhook coincida con el secreto. Esto ayuda a garantizar que la entrega del webhook proviene de Fluid. Para más información, consulte Validación de webhooks
El secreto de webhook debe ser una cadena de texto aleatoria con alta entropía. Debe almacenar de forma segura su secreto de webhook de manera que su servidor pueda acceder a él.
PAT Tokens
Los PAT tokens se generan desde sus sistemas; son tokens de portador (bearer tokens) que se pasarán al endpoint de la URL en el encabezado Authorization. Sus sistemas verificarán entonces el bearer token y permitirán el acceso si está autenticado/autorizado.
Basic Authentication
Estos son los detalles de nombre de usuario y contraseña que se pasarán en el encabezado Authorization. Sus sistemas verificarán entonces el nombre de usuario y la contraseña y permitirán el acceso si está autenticado/autorizado.
Request Parameters
Defina una lista delimitada por comas de los campos que desea incluir como parte del payload del webhook. P. ej., si solo desea recibir las propiedades Title y Description de la Acción, use "Title,Description"
Si no se establece, se usará una lista predeterminada de campos definida de antemano.
Solo configure valores aquí si desea optimizar el payload de datos que se envía como parte de la solicitud del webhook. Reducir el tamaño del payload aumentará el rendimiento al analizar los resultados.
Nota: Los parámetros de solicitud solo aplican a la Entidad Acción en sí.
Expand Parameters
Defina una lista delimitada por comas de datos opcionales que desea incluir como parte del payload del webhook. P. ej., si desea recibir los Chats de la Acción, use "Chats" o "Chat,Related" para obtener tanto Chat como Related.
Si no se establece, no se devolverá ninguna opción expandida. Recibirá el conjunto de datos predeterminado estándar para una Acción.
Las opciones de expansión admitidas incluyen:
-
All
Expandirá todas las opciones disponibles para la acción y devolverá el conjunto completo de datos.
-
Method
Incluirá los datos de Method para la Acción. Los Methods son enlaces URL a llamadas específicas que se pueden realizar sobre esta acción. Son URLs auxiliares.
-
Related
Cualquier otra acción que esté relacionada con esta Acción
-
Chats
Información de comentarios/chat disponible para esta Acción.
Triggers
Defina el tipo de eventos para los que desea recibir mensajes de webhook. Puede activar Sí/No para controlar qué eventos se enviarán.
Lecturas adicionales