Los webhooks permiten crear o configurar integraciones, como GitHub Apps o OAuth Apps, que se suscriben a determinados eventos en GitHub.com. Cuando se activa alguno de esos eventos, enviamos una carga útil de POST por HTTP a la URL que el webhook tiene configurada. Los webhooks pueden utilizarse para actualizar un rastreador de problemas externo, activar compilaciones de IC, actualizar un espejo de respaldo, o incluso para desplegar en tu servidor productivo. Solo te limita tu imaginación.
Los webhooks se pueden instalar en GitHub Enterprise, una organización, un repositorio específico o una GitHub App. Una vez que se instalan, el webhook se enviará cada vez que ocurra uno o más eventos suscritos.
Puede crear hasta 250� webhooks para cada evento en cada destino de instalación (instancia, organización específica o repositorio específico de GitHub Enterprise Server).
Eventos
Cuando configuras un webhook, puedes utilizar la IU o la API para elegir qué eventos te enviarán cargas útiles. El suscribirte únicamente a los eventos específicos que pretendes gestionar limita la cantidad de solicitudes HTTP a tu servidor. También puedes suscribirte a todos los eventos futuros y actuales. Predeterminadamente, los webhooks solo se suscriben al evento de carga. Puedes cambiar la lista de eventos a los que te suscribiste en cualquier momento.
Cada evento corresponde a conjuntos de acciones específicos que pueden suceder en tu organización y/o repositorio. Por ejemplo, si se suscribe al evento issues
, recibirá cargas útiles detalladas cada vez que una incidencia se abra, se cierre, se etiquete, etc.
Para obtener una lista completa de los eventos de webhook disponibles y sus cargas, vea "Eventos y cargas de webhook".
Evento de Ping
Cuando crea un webhook, le enviaremos un evento de ping
sencillo para informarle que ha configurado el webhook correctamente. Este evento no se almacena, por lo que no se puede recuperar mediante el punto de conexión de la API de Eventos.
Para obtener más información sobre la carga del webhook del evento ping
, vea el evento ping
.