Crear webhooks

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 y GitHub Sponsors. También puede configurar un GitHub App para recibir webhooks cuando se produzcan eventos específicos en los datos GitHub.

Para obtener más información sobre los diferentes tipos de webhooks, consulte "Acerca 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.
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 «Validating webhook deliveries».
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 "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 Your organizations (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 «Validating webhook deliveries».
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 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. Para obtener más información, vea «Eventos de webhook para la API de 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 «Validating webhook deliveries».
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, vea «Eventos y cargas de webhook».

Cear un webhook GitHub Sponsors

Puede crear un webhook para suscribirse a eventos relacionados con GitHub Sponsors. Solo el propietario de la cuenta patrocinada puede crear webhooks de patrocinio para esa cuenta. Para obtener más información, vea «Configurar los webhooks para los eventos en tu cuenta patrocinada».

Crear webhooks para GitHub App

Puede suscribir su GitHub App a eventos de webhook para recibir notificaciones cada vez que se produzca cierta actividad. Para obtener más información, vea «Registro de una instancia de GitHub App» y «Uso de webhooks con aplicaciones de GitHub».

Información adicional

• "Identificar las entregas de los webhooks"