Los webhooks de repositorio te permiten recibir cargas útiles de POST
por HTTP cuando ciertos eventos suceden en un repositorio. Las API de REST de los webhooks te permiten administrar webhooks de repositorio, organización y aplicación.. 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 de SSL, y el secreto. Para obtener más información, consulta:
- API de REST para los webhooks de los repositorios
- API de REST de webhooks de organización
- GitHub App API de REST de Webhooks
Si te gustaría configurar un solo webhook para recibir eventos de todos los repositorios de tu organización, consulta nuestra documentación de la API para los Webhooks de una Organización.
Adicionalmente a la API de REST, GitHub también puede servir como un punto de PubSubHubbub para los repositorios.
Recibir Webhooks
Para que GitHub Enterprise Server envíe cargas útiles de webhooks, se necesita que se pueda acceder a tu servidor desde la internet. También sugerimos ampliamente utilizar SSL para que podamos enviar cargas útiles cifradas a través de HTTPS.
Encabezados de Webhook
GitHub Enterprise Server enviará varios encabezados de HTTP para diferenciar los tipos de eventos y los identificadores de las cargas útiles. Consulta la sección de encabezados de webhook para encontrar más detalles.
PubSubHubbub
GitHub también puede fungir como un centro de PubSubHubbub para todos los repositorios. PSHB es un proptocolo simple de publicación/suscripción que permite a los servidores registrarse para recibir actualizaciones de cuándo se actualiza un tema. Las actualizaciones se mandan con una solicitud HTTP de tipo POST a una URL de rellamado. Las URL de tema para las cargas a un repositorio de GitHub están en este formato:
https://github.com/{owner}/{repo}/events/{event}
El veneto puede ser cualquier evento de webhook disponible. Para obtener más información, consulta la sección "eventos y cargas útiles de los webhooks".
Formato de respuesta
El formato predeterminado es lo que deberían esperar los ganchos de post-recepción: Un cuerpo de JSON que se envía como un parámetro de payload
en un POST. También puedes especificar si quieres recibir el cuerpo en JSON sin procesar, ya sea un encabezado de Accept
o una extensión .json
.
Accept: application/json
https://github.com/{owner}/{repo}/events/push.json
URL de Rellamado
Las URL de rellamado puede utilizar el protocolo http://
.
# Send updates to postbin.org
http://postbin.org/123
Suscribirse
La terminal de PubSubHubbub de GitHub es: http(s)://[hostname]/api/v3/hub
. Una solicitud exitosa con curl se vería así:
curl -u "user" -i \
http(s)://[hostname]/api/v3/hub \
-F "hub.mode=subscribe" \
-F "hub.topic=https://github.com/{owner}/{repo}/events/push" \
-F "hub.callback=http://postbin.org/123"
Las solicitudes de PubSubHubbub pueden enviarse varias veces. Si el gancho ya existe, se modificará de acuerdo con la solicitud.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
hub.mode | secuencia | Requerido. Ya sea subscribe o unsubscribe . |
hub.topic | secuencia | Requerido. La URI del repositorio de GitHub al cual suscribirse. La ruta debe estar en el formato /{owner}/{repo}/events/{event} . |
hub.callback | secuencia | La URI para recibir las actualizaciones del tema. |
hub.secret | secuencia | Una llave de secreto compartido que genera una firma de hash del contenido saliente del cuerpo. Puedes verificar si una subida vino de GitHub comparando el cuerpo de la solicitud sin procesar con el contenido de los encabezados de la X-Hub-Signature o X-Hub-Signature-256 . Puedes ver la documentación de PubSubHubbub para obtener más detalles. |