Crear webhooks

En este artículo

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

Acerca de crear webhooks

Puede crear webhooks para suscribirse a eventos específicos en GitHub que se producen en un repositorio, organización o cuentas GitHub Marketplace, GitHub Sponsors account, 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 "Webhooks de repositorio".

  1. En GitHub.com, 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, consulta «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 "Webhooks de organización".

  1. En la esquina superior derecha de cualquier página en GitHub.com, 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, consulta «Eventos y cargas de webhook».

Crear un webhook GitHub Marketplace

Puede crear un webhook para suscribirse a eventos relacionados con una aplicación que publicó en GitHub Marketplace. Solo el propietario de la aplicación, o un administrador de aplicaciones para la organización que posee la aplicación, puede crear un webhook GitHub Marketplace.

  1. Ve a tu página de lista de GitHub Marketplace.
  2. Junto a la lista de GitHub Marketplace para la que deseas ver las entregas de webhooks, haz clic en Administrar lista.
  3. En la barra lateral, haz clic en Webhook.
  4. En "Dirección URL de carga útil", escriba la dirección URL donde desea recibir cargas útiles.
  5. 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.
  6. 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».
  7. Para que el webhook se active inmediatamente después de agregar la configuración, selecciona Activo.
  8. Haga clic en Create webhook (Crear 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, consulta «Eventos y cargas de webhook».

Cear un webhook GitHub Sponsors

Puede crear un webhook para suscribirse a eventos relacionados con sus patrocinios. Solo el propietario de la cuenta patrocinada puede crear webhooks de patrocinio para esa cuenta. Para obtener más información sobre el evento al que se suscribe un webhook de patrocinio, consulte el sponsorship evento de webhook.

  1. En la esquina superior derecha de cualquier página, haga clic en su foto de perfil y luego en Your sponsors (Sus patrocinadores).
  2. Junto a la cuenta para la que desea crear un webhook, haga clic en Panel.
  3. En la barra lateral de la izquierda, haga 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. Para que el webhook se active inmediatamente después de agregar la configuración, selecciona Activo.
  9. Haga clic en Create webhook (Crear 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, consulta «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, haga clic en su fotografía de perfil.

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

    • Para una GitHub App que pertenezca a una cuenta personal, haga clic en Configuración.
    • Para una GitHub App que pertenezca a 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, consulta «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, consulta «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, consulta «Webhooks de aplicaciones de GitHub».

Información adicional