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 lo básico de los webhooks, vamos a revisar el proceso de creación de nuestra propia integración impulsada por webhooks. 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 de REST de los webhooks te permiten administrar los webhooks de repositorios , organizaciones y aplicaciones. Puedes utilizar esta API para listar las entregas de listas de webhooks para un webhook u obtener y volver a hacer entregas individuales para un webhook, el cual se pueda integrar en un servicio o app externa. También puedes utilizar la API de 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 SSL y el secreto. Para obtener más información, consulta las secciones:

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, consulta la página de descarga de ngrok.

Después de instalar ngrok, puedes exponer a tu host local si ejecutas ./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

Anota la URL de *.ngrok.io. La utilizaremos para configurar nuestro webhook.

Configurar 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 ahí, da clic en Webhooks, y luego en Agregar webhook.

Como alternativa, puedes elegir el crear y administrar un webhook através de 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.

URL de la carga útil

La URL de carga útil es la URL del servidor que recibirá las solicitudes de POST del webhook.

Ya que estamos desarrollando todo localmente para nuestro tutorial, lo configuraremos en la URL *.ngrok.io, seguido 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 útil de JSON directametne como el cuerpo de la solicitud POST.
  • El tipo de contenido application/x-www-form-urlencoded enviará la carga útil de JSON como un parámetro de forma llamado payload.

Elige el que se adapte mejor a tus necesidades. Para efecto de este tutorial, está bien si usas el tipo de contenido predeterminado de application/json.

Secreto

El configurar un secreto de webhook te permite garantizar que las solicitudes POST que se enviaron a la URL de la carga útil sean de GitHub. Cuando configuras un secreto, recibirás los encabezados de X-Hub-Signature y de X-Hub-Signature-256 en la solicitud de POST del webhook. Para obtener más información sobre cómo utilizar uns ecreto con un encabezado de firma para asegurar tus cárgas útiles de webhook, consulta la sección "Asegurar tus 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. Tienes la opción de inhabilitar SSL, pero te recomendamos que mantengas seleccionado 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.

Puedes encontrar un listado completo de eventos de webhook y del cuándo se ejecutan en la referencia de la API de webhooks.

Ya que nuestro webhook trata con informes de problemas en un repositorio, vamos a dar clic en Permíteme seleccionar eventos individuales y, posteriormente, en Informes de problemas. Asegúrate de seleccionar Activo para recibir eventos de los informes de problemas para los webhooks que se activen. También puedes seleccionar todos los eventos utilizando la opción predeterminada.

Cuando hayas terminado, da clic en Agregar webhook.

Ahora que creaste el webhook, es momento de configurar nuestro servidor local para probarlo. Dirígete a Configurar tu Servidor para aprender cómo hacerlo.

Evento de comodín

Para configurar un webhook para todos los eventos, utiliza el caracter de comodín (*) para especificar dichos 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.

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.