Skip to main content

Crear webhooks

Aprende a crear un webhook, escoger los eventos a los cuales escuchará en GitHub y cómo configurar un servidor para recibir y administrar su carga útil.

Ahora que entendemos los conceptos básicos de los webhooks, vamos a recorrer el proceso de creación de nuestra propia integración con tecnología de webhook. En este tutorial, crearemos un webhook de repositorio que será responsable de listar qué tan popular es nuestro repositorio con base en la cantidad de propuestas que recibe diariamente.

Crear un webhook es un proceso de dos pasos. Primero necesitas configurar la forma en la que quieres que se comporte tu webhook a través de GitHub, es decir: a qué eventos quieres que escuche. Después, configurarás tu servidor para recibir y administrar la carga útil.

Las API REST de webhook permiten administrar webhooks de repositorio, organización y aplicación. Puede usar esta API para enumerar las entregas de webhook para un webhook, o bien obtener y volver a realizar una entrega individual para uno de ellos, lo que se puede integrar en una aplicación o servicio externo.. También puede usar la API REST para cambiar la configuración del webhook. Por ejemplo, puedes modificar la URL de la carga útil, el tipo de contenido, la verificación de SSL, y el secreto. Para más información, consulte:

Exponer un host local al internet

Para los propósitos de este tutorial, utilizaremos un servidor local para recibir imágenes de GitHub. Así que, primero que nada, necesitamos exponer nuestro ambiente de desarrollo local al internet. Utilizaremos ngrok para hacerlo. ngrok está disponible, gratuitamente, para los sistemas operativos principales. Para obtener más información, consulte la página de descarga de ngrok.

Después de instalar ngrok, puede exponer el host local ejecutando ./ngrok http 4567 en la línea de comandos. el número de puerto en el que nuestro servidor escuchará mensajes es el 4567. Deberías ver una línea que se ve más o menos así:

$ Forwarding    http://7e9ea9dc.ngrok.io -> 127.0.0.1:4567

Anote los valores de la dirección URL de *.ngrok.io. La utilizaremos para configurar nuestro webhook.

Configuración de un webhook

Puedes instalar webhooks en una organización o en un repositorio específico.

Para configurar un webhook, ve a la página de configuración de tu repositorio u organización. Desde allí, haga clic en Webhooks y, a continuación, en Add webhook.

También puede elegir compilar y administrar un webhook desde la API de webhooks.

Los Webhooks necesitan configurar algunas de sus opciones antes de que los puedas utilizar. Vamos a ver cada una de éstas opciones a continuación.

Dirección URL de carga

La dirección URL de la carga es la dirección URL del servidor que va a recibir las solicitudes POST del webhook.

Dado que estamos desarrollando a nivel local para nuestro tutorial, lo estableceremos en la dirección URL de *.ngrok.io, seguida de /payload. Por ejemplo, http://7e9ea9dc.ngrok.io/payload.

Tipo de contenido

Los webhooks pueden entregarse utilizando diferentes tipos de contenido:

  • El tipo de contenido application/json entregará la carga JSON directamente como el cuerpo de la solicitud POST.
  • El tipo de contenido application/x-www-form-urlencoded enviará la carga JSON como un parámetro de formulario denominado payload.

Elija el que mejor se ajuste a sus necesidades. Para este tutorial, el tipo de contenido predeterminado application/json está bien.

Secreto

Configurar un secreto de webhook permite garantizar que las solicitudes POST que se enviaron a la URL de la carga útil sean de GitHub. Al establecer un secreto, recibirá los encabezados X-Hub-Signature y X-Hub-Signature-256, y el encabezado en la solicitud POST de webhook. Para obtener más información sobre cómo utilizar un secreto con un encabezado de firma para proteger sus cárgas útiles de webhook, vea la sección "Proteger los webhooks".

Verificación SSL

Si tu "URL de carga útil" es un sitio seguro (HTTPS), tendrás la opción de configurar los ajustes de verificación de SSL. Si tu "URL de carga útil" no es segura (HTTP), GitHub no mostrará esta opción. Predeterminadamente, GitHub verifica el certificado SSL de tu sitio web cuando entrega cargas útiles de webhooks. La verificación de SSL ayuda a garantizar que las cargas útiles de los ganchos se entregan en tu terminal URL de forma segura. Tiene la opción de deshabilitar SSL, pero le recomendamos que mantenga seleccionado Enable SSL verification (Habilitar la verificación SSL).

Activo

Predeterminadamente, las entregas de webhook están "Activas". También puedes elegir inhabilitar la entrega de cargas útiles de webhooks si deseleccionas "Activo".

Eventos

Los eventos son el núcleo de los webhooks. Estos webhooks se disparan cuando se toma alguna acción específica en el repositorio, la cual intercepta tu URL de carga útil de l servidor para actuar sobre ella.

Encontrará una lista completa de eventos de webhook, especificando cuándo se ejecutan, en la referencia de la API de webhooks.

Dado que nuestro webhook gestiona las incidencias de un repositorio, haremos clic en Let me select individual events y, a continuación, en Issues. Asegúrese de seleccionar Active (Activo) para recibir eventos de problema para los webhook desencadenados. También puedes seleccionar todos los eventos utilizando la opción predeterminada.

Cuando haya terminado, haga clic en Add webhook.

Ahora que creaste el webhook, es momento de configurar nuestro servidor local para probarlo. Vaya a Configuración del servidor para saber cómo hacerlo.

Evento de comodín

Para configurar un webhook para todos los eventos, utilice el carácter comodín (*) para especificar los eventos. Cuando agregas el evento de comodín, reemplazaremos cualquier evento existente que hayas configurado con el evento de comodín se te enviarán las cargas útiles para todos los eventos compatibles. También obtendrás automáticamente cualquier evento nuevo que pudiéramos agregar posteriormente.