Webhooks

Probar webhooks

Esto le permitirá verificar que Fluid envíe una entrega de webhook en respuesta a un evento que usted espera que active una entrega de webhook.

También puede probar el código que maneja las entregas de webhook usando su computadora como servidor local y reenviando las entregas de webhook a su servidor local. Esto le permitirá desarrollar y depurar su código sin implementarlo en su servidor de producción.


Probar la entrega de webhook

Puede activar un evento de webhook y verificar que Fluid envió una entrega de webhook.

  • Active su webhook. Por ejemplo, si está probando un webhook de Acción que está suscrito al evento de creación, cree una Acción en el tablero donde está configurado el webhook.

  • Si está utilizando un webhook de organización o de repositorio, también puede usar la API REST para activar el evento ping de su webhook. 

  • Consulte Fluid para verificar que se envió una entrega de webhook.

Si no se envió una entrega de webhook, o si se envió una entrega de webhook pero Fluid indica que la entrega falló, consulte la guía de solución de problemas para ayudar a diagnosticar el problema. Para obtener más información, consulte Solución de problemas de webhooks.


Probar el código de webhook localmente

Para probar el código de su webhook localmente en su computadora, puede usar una URL de proxy de webhook para reenviar webhooks de Fluid a su computadora o codespace. Puede usar su computadora como servidor local para recibir estos webhooks reenviados.

Las siguientes secciones muestran cómo usar ngrok http://ngrok.com para proporcionar una URL de proxy de webhook y reenviar webhooks. También se pueden usar otras alternativas como http://smee.io.

Para ver ejemplos específicos de código y pasos de prueba, consulte  Manejo de entregas de webhook.


Obtener una URL de proxy de webhook

  1. En su navegador, vaya a http://ngrok.com.

  2. Regístrese, si aún no lo ha hecho. El registro es gratuito

  3. Consulte https://ngrok.com/download para instalar ngrok.

  4. En una ventana de cmd, ejecute ngrok http<puerto> donde <puerto> es el número de puerto en el que escucha su servidor local.

  5. Vaya al panel local de ngrok en http://localhost:4040 para encontrar la información de su URL pública en la pestaña de estado.

Para instancias de IISExpress que se ejecutan en localhost, deberá configurar el http-header como parte de su configuración de ngrok para que ngrok reenvíe correctamente. Reemplace [port] con el número de puerto de su instancia en ejecución.

ngrok http [port] --host-header="localhost:[port]"



Configurar un webhook para usar la URL de proxy de webhook

Configure su webhook para que use la URL de proxy de webhook indicada anteriormente. Para obtener más información, consulte Cómo configurar la integración de Webhooks con Fluid Boards.

Ahora, Fluid enviará entregas de webhook a esa URL.


Iniciar un servidor local

En su computadora, inicie un servidor local. La forma de hacerlo depende de cómo esté escrito el código para recibir webhooks. Para ver ejemplos, consulte Manejo de entregas de webhook

Debe asegurarse de que su código pueda ejecutarse localmente. Por ejemplo, si su código depende de variables de entorno en su servidor de producción, debe asegurarse de que esas variables de entorno también estén disponibles en su servidor local.

También puede resultarle útil agregar instrucciones de registro para verificar que los pasos de su código se ejecutaron como se esperaba.

Mantenga su servidor local en ejecución mientras prueba su webhook.


Reenviar webhooks

1. Si aún no tiene ngrok instalado, ejecute el siguiente comando en su terminal:

choco install ngrok

2. Para recibir los webhooks reenviados desde ngrok, ejecute el siguiente comando en su terminal. Reemplace PORT con el puerto en el que escucha su servidor local.

ngrok http PORT

Para instancias de IISExpress que se ejecutan en localhost, deberá configurar el http-header como parte de su configuración de ngrok para que ngrok reenvíe correctamente. Reemplace [port] con el número de puerto de su instancia en ejecución.
ngrok http [port] --host-header="localhost:[port]"


Ahora, cuando su URL de proxy de webhook (la URL pública de ngrok que se encuentra en http://localhost:4040) reciba una entrega de webhook de Fluid, ngrok reenviará la entrega de webhook a su servidor local.

3. Mantenga esto en ejecución mientras prueba su webhook. Cuando desee detener el reenvío de webhooks, presione Ctrl+C.

En este punto, debe tener tanto su servidor local como el reenvío de ngrok en ejecución.


Activar una entrega de webhook

Active su webhook. Por ejemplo, si está probando un webhook de repositorio que está suscrito al evento de problemas, abra un problema en el repositorio donde está configurado el webhook.


Verificar entrega

Puede verificar que Fluid envió una entrega de webhook, que ngrok recibió y reenvió la entrega, y que su servidor local procesó la entrega de webhook.


Verificar que Ngrok recibió su entrega de webhook

Vaya a su panel de ngrok en http://localhost:4040. En la pestaña de inspección, debería ver un evento que corresponde al evento que activó. Esto indica que Fluid envió correctamente una entrega de webhook a la URL de payload que especificó.

Si no ve su entrega de webhook en ngrok, verifique que su webhook esté usando su URL de proxy de webhook (URL de ngrok que se encuentra en la pestaña de estado de su panel de ngrok http://localhost:4040).


Verificar que su servidor local procesó la entrega de webhook

En este punto, ha verificado que Fluid envió una entrega de webhook y que ngrok reenvió la entrega a su servidor local. Ahora, debe verificar que su código procesó la entrega de webhook como se esperaba. La forma de hacerlo depende de cómo esté escrito el código para recibir webhooks. Para ver ejemplos, consulte Manejo de entregas de webhook.

Was this article helpful?