Los webhooks de repositorio le permiten recibir cargas útiles de POST
HTTP cuando se producen determinados eventos en un repositorio. Las API REST de webhook permiten administrar webhooks de repositorio, organización y aplicación.. 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:
- API REST de webhook de repositorio
- API REST de webhook de organización
- GitHub App API REST de webhooks
Si quiere configurar un solo webhook para recibir eventos de todos los repositorios de la organización, vea nuestra documentación de la API para Webhooks de una organización.
Además de la API REST, GitHub también puede servir como centro 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. Vea encabezados de webhook para más información.
PubSubHubbub
GitHub también puede servir 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 más información, vea "Eventos y cargas de webhook".
Formato de respuesta
El formato predeterminado es lo que deben esperar los enlaces posteriores a la recepción existentes: un cuerpo JSON enviado como parámetro payload
en una solicitud POST. También puede especificar que el cuerpo JSON sin formato se reciba con un encabezado Accept
o una extensión .json
.
Accept: application/json
https://github.com/{owner}/{repo}/events/push.json
URL de Rellamado
Las URL de devolución de llamada pueden usar el protocolo http://
.
# Send updates to postbin.org
http://postbin.org/123
Suscribirse
El punto de conexión 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 | string | Requerido. subscribe o unsubscribe . |
hub.topic | string | Requerido. La URI del repositorio de GitHub al cual suscribirse. La ruta debe tener el formato /{owner}/{repo}/events/{event} . |
hub.callback | string | La URI para recibir las actualizaciones del tema. |
hub.secret | string | Una llave de secreto compartido que genera una firma de hash del contenido saliente del cuerpo. Para comprobar que una inserción procede de GitHub, compara el cuerpo de la solicitud sin formato con el contenido de X-Hub-Signature o X-Hub-Signature-256 los encabezados. Puede ver la documentación de PubSubHubbub para obtener más detalles. |