Los Webhooks te permiten crear y configurar integraciones, tales como App GitHub o App OAuth, las cuales se suscriben a ciertos 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 una instancia de GitHub Enterprise Server, unaorganización, un repositorio específico, o una App GitHub. Una vez que se instalan, el webhook se enviará cada vez que ocurra uno o más eventos suscritos.
Puedes crear hasta 250 webhooks para cada evento en cada destino de instalación (instancia de GitHub Enterprise Server, organización específica, o repositorio específico).
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 te suscribes al evento issues
, recibirás cargas útiles detalladas cada vez que un informe de problemas se abra, cierre, etiquete, etc.
Consulta la sección "Cargas útiles de los eventos de webhook" para encontrar una lista de los eventos de webhook disponibles y de sus cargas útiles.
Evento de Ping
Cuando creas un webhook nuevo, te enviaremos un evento de ping
sencillo para informarte que configuraste el webhook correctamente. Este evento no se almacena, así que no se puede recuperar a través de la API de Eventos. Puedes activar nuevamente un ping
si llamas a la terminal Hacer ping a un webhook del repositorio.
Para obtener más información acerca de la carga útil del webhook del evento ping
, consulta el evento ping
.