Puntos de conexión de la API de REST para webhooks de GitHub App

Acerca de webhooks en GitHub Apps

Un webhook de GitHub App te permite recibir cargas HTTP POST siempre que se produzcan determinados eventos para una GitHub App. Para más información, consulta Documentación de webhooks y Uso de webhooks con aplicaciones de GitHub.

Get a webhook configuration for an app

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

You must use a JWT to access this endpoint.

Tokens de acceso específicos para "Get a webhook configuration for an app"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Códigos de estado de respuesta HTTP para "Get a webhook configuration for an app"

status code	Descripción
`200`	OK

Ejemplos de código para "Get a webhook configuration for an app"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/app/hook/config

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/hook/config

Response

Status: 200

{
  "content_type": "json",
  "insecure_ssl": "0",
  "secret": "********",
  "url": "https://example.com/webhook"
}

Update a webhook configuration for an app

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

You must use a JWT to access this endpoint.

Tokens de acceso específicos para "Update a webhook configuration for an app"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Update a webhook configuration for an app"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`url` string The URL to which the payloads will be delivered.
`content_type` string The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
`secret` string If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for delivery signature headers.
`insecure_ssl` string or number Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.

Códigos de estado de respuesta HTTP para "Update a webhook configuration for an app"

status code	Descripción
`200`	OK

Ejemplos de código para "Update a webhook configuration for an app"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

patch/app/hook/config

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/hook/config \
  -d '{"content_type":"json","insecure_ssl":"0","secret":"********","url":"https://example.com/webhook"}'

Response

Status: 200

{
  "content_type": "json",
  "insecure_ssl": "0",
  "secret": "********",
  "url": "https://example.com/webhook"
}

List deliveries for an app webhook

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

Tokens de acceso específicos para "List deliveries for an app webhook"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "List deliveries for an app webhook"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`cursor` string Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.

Códigos de estado de respuesta HTTP para "List deliveries for an app webhook"

status code	Descripción
`200`	OK
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "List deliveries for an app webhook"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/app/hook/deliveries

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/hook/deliveries

Response

Status: 200

[
  {
    "id": 12345678,
    "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
    "delivered_at": "2019-06-03T00:57:16Z",
    "redelivery": false,
    "duration": 0.27,
    "status": "OK",
    "status_code": 200,
    "event": "issues",
    "action": "opened",
    "installation_id": 123,
    "repository_id": 456,
    "throttled_at": "2019-06-03T00:57:16Z"
  },
  {
    "id": 123456789,
    "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
    "delivered_at": "2019-06-04T00:57:16Z",
    "redelivery": true,
    "duration": 0.28,
    "status": "OK",
    "status_code": 200,
    "event": "issues",
    "action": "opened",
    "installation_id": 123,
    "repository_id": 456,
    "throttled_at": null
  }
]

Get a delivery for an app webhook

Returns a delivery for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.

Tokens de acceso específicos para "Get a delivery for an app webhook"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Get a delivery for an app webhook"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`delivery_id` integer Requerido

Códigos de estado de respuesta HTTP para "Get a delivery for an app webhook"

status code	Descripción
`200`	OK
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Get a delivery for an app webhook"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/app/hook/deliveries/{delivery_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/hook/deliveries/DELIVERY_ID

Response

Status: 200

{
  "id": 12345678,
  "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
  "delivered_at": "2019-06-03T00:57:16Z",
  "redelivery": false,
  "duration": 0.27,
  "status": "OK",
  "status_code": 200,
  "event": "issues",
  "action": "opened",
  "installation_id": 123,
  "repository_id": 456,
  "url": "https://www.example.com",
  "throttled_at": "2019-06-03T00:57:16Z",
  "request": {
    "headers": {
      "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
      "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
      "Accept": "*/*",
      "X-GitHub-Hook-ID": "42",
      "User-Agent": "GitHub-Hookshot/b8c71d8",
      "X-GitHub-Event": "issues",
      "X-GitHub-Hook-Installation-Target-ID": "123",
      "X-GitHub-Hook-Installation-Target-Type": "repository",
      "content-type": "application/json",
      "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
    },
    "payload": {
      "action": "opened",
      "issue": {
        "body": "foo"
      },
      "repository": {
        "id": 123
      }
    }
  },
  "response": {
    "headers": {
      "Content-Type": "text/html;charset=utf-8"
    },
    "payload": "ok"
  }
}

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`delivery_id` integer Requerido

Códigos de estado de respuesta HTTP para "Redeliver a delivery for an app webhook"

status code	Descripción
`202`	Accepted
`400`	Bad Request
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Redeliver a delivery for an app webhook"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

post/app/hook/deliveries/{delivery_id}/attempts

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/app/hook/deliveries/DELIVERY_ID/attempts

Accepted

Status: 202

Puntos de conexión de la API de REST para webhooks de GitHub App

Acerca de webhooks en GitHub Apps

Get a webhook configuration for an app

Tokens de acceso específicos para "Get a webhook configuration for an app"

Códigos de estado de respuesta HTTP para "Get a webhook configuration for an app"

Ejemplos de código para "Get a webhook configuration for an app"

Ejemplo de solicitud

Response

Update a webhook configuration for an app

Tokens de acceso específicos para "Update a webhook configuration for an app"

Parámetros para "Update a webhook configuration for an app"

Códigos de estado de respuesta HTTP para "Update a webhook configuration for an app"

Ejemplos de código para "Update a webhook configuration for an app"

Ejemplo de solicitud

Response

List deliveries for an app webhook

Tokens de acceso específicos para "List deliveries for an app webhook"

Parámetros para "List deliveries for an app webhook"

Códigos de estado de respuesta HTTP para "List deliveries for an app webhook"

Ejemplos de código para "List deliveries for an app webhook"

Ejemplo de solicitud

Response

Get a delivery for an app webhook

Tokens de acceso específicos para "Get a delivery for an app webhook"

Parámetros para "Get a delivery for an app webhook"

Códigos de estado de respuesta HTTP para "Get a delivery for an app webhook"

Ejemplos de código para "Get a delivery for an app webhook"

Ejemplo de solicitud

Response

Redeliver a delivery for an app webhook

Tokens de acceso específicos para "Redeliver a delivery for an app webhook"

Parámetros para "Redeliver a delivery for an app webhook"

Códigos de estado de respuesta HTTP para "Redeliver a delivery for an app webhook"

Ejemplos de código para "Redeliver a delivery for an app webhook"

Ejemplo de solicitud

Accepted