Esta versión de GitHub Enterprise Server se discontinuó el 2024-07-09. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Crear webhooks

You can create webhooks to subscribe to specific events that occur on GitHub.

En este artículo

Acerca de crear webhooks

Puedes crear webhooks para suscribirte a eventos específicos en GitHub que se producen en un repositorio, organización o cuentas GitHub Enterprise, o GitHub App.

Para obtener más información sobre los diferentes tipos de webhooks, consulte "Tipos de webhooks".

Para una lista completa de eventos de webhook, consulta "Eventos y cargas de webhook".

Crear un webhook de repositorio

Puede crear un webhook para suscribirse a eventos concretos de un repositorio. Debe ser propietario del repositorio o tener acceso de administrador en el repositorio para crear webhooks en ese repositorio.

Puede usar la interfaz web de GitHub o la API de REST para crear un webhook de repositorio. Para obtener más información sobre el uso de la API de REST para crear un webhook de repositorio, consulte "Puntos de conexión de la API de REST para los webhooks de repositorio".

  1. En tu instancia de GitHub Enterprise Server, navega a la página principal del repositorio.

  2. En el nombre del repositorio, haz clic en Configuración. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la barra lateral de la izquierda, haz clic en Webhooks.

  4. Haga clic en Agregar webhook.

  5. En "Dirección URL de carga útil", escriba la dirección URL donde desea recibir cargas útiles.

  6. Opcionalmente, selecciona el menú desplegable Tipo de contenido y haz clic en un formato de datos para recibir la carga del webhook.

    • application/json entrega la carga últil de JSON directamente como el cuerpo de una solicitud POST.
    • El tipo de contenido application/x-www-form-urlencoded envía la carga útil de JSON como un parámetro de formulario, llamado payload.

  7. Opcionalmente, en el campo “Secreto”, escriba una cadena que se usará como clave secret. Debes elegir una cadena aleatoria de texto con alta entropía. Puede usar el secreto de webhook para limitar las solicitudes entrantes solo a las que se originan en GitHub. Para obtener más información, vea «Validación de entregas de webhook».

  8. En "¿Qué eventos desea desencadenar este webhook?", seleccione los eventos de webhook que desea recibir. Debes suscribirte solo a los eventos de webhook que necesitas.

  9. Si elige Seleccionar eventos individuales, seleccione los eventos que quiere que se activen en el webhook.

  10. Para que el webhook se active inmediatamente después de agregar la configuración, selecciona Activo.

  11. Haga clic en Agregar webhook.

Después de crear un nuevo webhook, GitHub le enviará un evento sencillo ping para informarle de que ha configurado el webhook correctamente. Para obtener más información, vea «Eventos y cargas de webhook».

Crear un webhook para una organización

Puede crear un webhook para suscribirse a eventos concretos de una organización. Debe ser propietario de la organización para crear webhooks en esa organización.

Puede usar la interfaz web de GitHub o la API de REST para crear un webhooks de una organización. Para obtener más información sobre el uso de la API de REST para crear un webhook de organización, consulte "Puntos de conexión de API REST para webhooks de organización".

  1. En la esquina superior derecha de cualquier página en tu instancia de GitHub Enterprise Server, haga clic en su fotografía de perfil.
  2. Haga clic en Sus organizaciones.
  3. A la derecha de la organización, haga clic en Configuración.
  4. En la barra lateral de la izquierda, haz clic en Webhooks.
  5. Haga clic en Agregar webhook.
  6. En "Dirección URL de carga útil", escriba la dirección URL donde desea recibir cargas útiles.
  7. Opcionalmente, selecciona el menú desplegable Tipo de contenido y haz clic en un formato de datos para recibir la carga del webhook.
    • application/json entrega la carga últil de JSON directamente como el cuerpo de una solicitud POST.
    • El tipo de contenido application/x-www-form-urlencoded envía la carga útil de JSON como un parámetro de formulario, llamado payload.
  8. Opcionalmente, en el campo “Secreto”, escriba una cadena que se usará como clave secret. Debes elegir una cadena aleatoria de texto con alta entropía. Puede usar el secreto de webhook para limitar las solicitudes entrantes solo a las que se originan en GitHub. Para obtener más información, vea «Validación de entregas de webhook».
  9. En "¿Qué eventos desea desencadenar este webhook?", seleccione los tipos de webhooks que desea recibir. Debes suscribirte solo a los eventos de webhook que necesitas.
  10. Si elige Seleccionar eventos individuales, seleccione los eventos que activarán el webhook.
  11. Para que el webhook se active inmediatamente después de agregar la configuración, selecciona Activo.
  12. Haga clic en Agregar webhook.

Después de crear un nuevo webhook, GitHub le enviará un evento sencillo ping para informarle de que ha configurado el webhook correctamente. Para obtener más información, vea «Eventos y cargas de webhook».

Crear un webhook global para GitHub Enterprise

Los propietarios de empresas pueden crear un webhook global para suscribirse a eventos que se producen dentro de su empresa.

Puedes usar la interfaz web de GitHub o la API de REST para crear un webhook global. Para obtener más información sobre el uso de la API de REST para crear un webhook global, consulta «Puntos de conexión de la API de REST para los webhooks globales».

  1. En la esquina superior derecha de GitHub Enterprise Server, haz clic en la foto de perfil y luego en Configuración de empresa.

    Captura de pantalla del menú desplegable que aparece al hacer clic en la foto de perfil en GitHub Enterprise Server. La opción "Configuración de Enterprise" está resaltada en un contorno naranja oscuro.

  2. En el lado izquierdo de la página, en la barra lateral de la cuenta de empresa, haz clic en Configuración.

  3. En " Configuración", haz clic en Enlaces.

  4. Haga clic en Agregar webhook.

  5. En el campo "Dirección URL de carga", escribe la dirección URL donde deseas recibir cargas.

  6. Opcionalmente, selecciona el menú desplegable Tipo de contenido y haz clic en un formato de datos para recibir la carga del webhook.

    • application/json entrega la carga últil de JSON directamente como el cuerpo de una solicitud POST.
    • El tipo de contenido application/x-www-form-urlencoded envía la carga útil de JSON como un parámetro de formulario, llamado payload.

  7. Opcionalmente, en el campo “Secreto”, escriba una cadena que se usará como clave secret. Debes elegir una cadena aleatoria de texto con alta entropía. Puede usar el secreto de webhook para limitar las solicitudes entrantes solo a las que se originan en GitHub. Para obtener más información, vea «Validación de entregas de webhook».

  8. Opcionalmente, si la URL de la carga es HTTPS y no quieres que GitHub Enterprise Server compruebe los certificados SSL cuando entregue las cargas, en "Comprobación de SSL", selecciona Deshabilitar. Lee la información sobre la comprobación SSL y, después, haz clic en Entiendo que mis webhooks pueden no ser seguros.

    Advertencia: La comprobación SSL ayuda a garantizar que las cargas de enlace se entreguen de forma segura. No es recomendable desactivar la verificación SSL.

  9. En "¿Qué eventos desea desencadenar este webhook?", seleccione los tipos de webhooks que desea recibir. Debes suscribirte solo a los eventos de webhook que necesitas.

  10. Si elige Seleccionar eventos individuales, seleccione los eventos que activarán el webhook.

  11. Para que el webhook se active inmediatamente después de agregar la configuración, selecciona Activo.

  12. Haga clic en Agregar webhook.

Crear webhooks para GitHub App

El propietario de GitHub App puede suscribir la aplicación a los eventos de webhook para recibir notificaciones cada vez que se produzca cierta actividad. Si una organización ha designado administradores de aplicaciones para una GitHub App que es propiedad de la organización, los administradores de aplicaciones también pueden suscribir la aplicación a los eventos de webhooks. Para obtener más información, vea «Uso de webhooks con aplicaciones de GitHub».

Cada GitHub App tiene un webhook. Puede configurar el webhook al registrar GitHub App, o bien puede editar la configuración del webhook para un registro existente de GitHub App.

Para obtener más información sobre configurar un webhook cuando registra GitHub App, consulte "Registro de una instancia de GitHub App".

Configurar un webhook para un registro existente de GitHub App:

  1. En la esquina superior derecha de cualquier página en GitHub Enterprise Server, haga clic en su fotografía de perfil.

  2. Navega a la configuración de tu cuenta.

    • Para una aplicación propiedad de una cuenta personal, haga clic en Configuración.
    • Para una aplicación propiedad de una organización:
      1. Haga clic en Sus organizaciones.
      2. A la derecha de la organización, haga clic en Configuración.

  3. En la barra lateral izquierda, haz clic en Configuración del desarrollador.

  4. En la barra lateral de la izquierda, haga clic en GitHub Apps .

  5. Junto a la GitHub App para la que quiere configurar el webhook, haga clic en Editar.

  6. En "Webhook", seleccione Activo.

  7. En "URL de Webhook", escriba la dirección URL donde desea recibir cargas útiles.

  8. Opcionalmente, en el campo “Secreto de Webhook”, escriba una cadena que se usará como clave secret. Debes elegir una cadena aleatoria de texto con alta entropía. Puede usar el secreto de webhook para limitar las solicitudes entrantes solo a las que se originan en GitHub. Para obtener más información, vea «Validación de entregas de webhook».

  9. Haga clic en Guardar cambios.

  10. En la barra lateral, haga clic en Permisos y eventos.

  11. Los eventos de webhook específicos que puede seleccionar en el registro de la GitHub App vienen determinados por el tipo de permisos que has seleccionado para la aplicación. En primer lugar, deberás seleccionar los permisos que deseas que tenga la aplicación y, a continuación, puedes suscribir la aplicación a eventos de webhook relacionados con ese conjunto de permisos.

    En las secciones "Repository permissions", "Organization permissions" y "Account permissions", seleccione los permisos necesarios para los eventos a los que se suscribirá la aplicación. Para obtener más información, vea «Elección de permisos para una aplicación de GitHub». Para obtener más información sobre qué se debe tener en cuenta al cambiar los permisos, consulte "Modificar un registro GitHub App."

  12. En "Subscribe to Events", seleccione los eventos de webhook que desea que reciba la instancia de GitHub App.

  13. Haga clic en Guardar cambios.

También puede usar la API de REST para crear un webhook para GitHub App. Para obtener más información, vea «Puntos de conexión de la API de REST para webhooks de GitHub App».

Información adicional