Webhooks globales

Usa la API de REST para administrar webhooks globales para tu empresa.

Acerca de los webhooks locales

Estos puntos de conexión solo están disponibles para los administradores de sitios autenticados. Los usuarios normales recibirán una respuesta 404. Para obtener información sobre cómo configurar webhooks globales, vea Acerca de los webhooks globales.

Los webhooks globales se instalan automáticamente en tu empresa. Puedes utilizar los webhooks globales para monitorear, responder a, o requerir las reglas para los usuarios, organizaciones, equipos y repositorios en tu empresa.

Los webhooks globales se pueden suscribir a los tipos de eventos de organización, usuario, repositorio, equipo, miembro, pertenencia, bifurcación y ping.

List global webhooks

Parameters

Headers
Nombre, Type, Descripción
`accept`string Setting to `application/vnd.github+json` is recommended.
Query parameters
Nombre, Type, Descripción
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	Descripción
`200`	OK

Code samples

get/admin/hooks

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks

Response

Status: 200

[
  {
    "type": "Global",
    "id": 1,
    "name": "web",
    "active": true,
    "events": [
      "organization",
      "user"
    ],
    "config": {
      "url": "https://example.com",
      "content_type": "json",
      "insecure_ssl": "0",
      "secret": "********"
    },
    "updated_at": "2017-12-07T00:14:59Z",
    "created_at": "2017-12-07T00:14:59Z",
    "url": "https://api.github.com/admin/hooks/1",
    "ping_url": "https://api.github.com/admin/hooks/1/pings"
  }
]

Create a global webhook

Parameters

Headers

Nombre, Type, Descripción

acceptstring

Setting to application/vnd.github+json is recommended.

Body parameters

Nombre, Type, Descripción

namestringRequired

Must be passed as "web".

configobjectRequired

Key/value pairs to provide settings for this webhook.

Properties of config

Nombre, Type, Descripción
`url`stringRequired 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 in the `X-Hub-Signature` header.
`insecure_ssl`string 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.

eventsarray of strings

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

activeboolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

Default: true

HTTP response status codes

Status code	Descripción
`201`	Created

Code samples

post/admin/hooks

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks \
  -d '{"name":"web","events":["organization","user"],"config":{"url":"https://example.com/webhook","content_type":"json","secret":"secret"}}'

Response

Status: 201

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization",
    "user"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "json",
    "insecure_ssl": "0",
    "secret": "********"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

Get a global webhook

Parameters

Headers
Nombre, Type, Descripción
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nombre, Type, Descripción
`hook_id`integerRequired The unique identifier of the hook.

HTTP response status codes

Status code	Descripción
`200`	OK

Code samples

get/admin/hooks/{hook_id}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID

Response

Status: 200

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization",
    "user"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "json",
    "insecure_ssl": "0",
    "secret": "********"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

Update a global webhook

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

Parameters

Headers

Nombre, Type, Descripción

acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters

Nombre, Type, Descripción

hook_idintegerRequired

The unique identifier of the hook.

Body parameters

Nombre, Type, Descripción

configobject

Key/value pairs to provide settings for this webhook.

Properties of config

Nombre, Type, Descripción
`url`stringRequired 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 in the `X-Hub-Signature` header.
`insecure_ssl`string 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.

eventsarray of strings

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

activeboolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

Default: true

HTTP response status codes

Status code	Descripción
`200`	OK

Code samples

patch/admin/hooks/{hook_id}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID \
  -d '{"events":["organization"],"config":{"url":"https://example.com/webhook"}}'

Response

Status: 200

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "form",
    "insecure_ssl": "0"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

Delete a global webhook

Parameters

Headers
Nombre, Type, Descripción
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nombre, Type, Descripción
`hook_id`integerRequired The unique identifier of the hook.

HTTP response status codes

Status code	Descripción
`204`	No Content

Code samples

delete/admin/hooks/{hook_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID

Response

Status: 204

Ping a global webhook

This will trigger a ping event to be sent to the webhook.

Parameters

Headers
Nombre, Type, Descripción
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nombre, Type, Descripción
`hook_id`integerRequired The unique identifier of the hook.

HTTP response status codes

Status code	Descripción
`204`	No Content

Code samples

post/admin/hooks/{hook_id}/pings

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/hooks/HOOK_ID/pings

Response

Status: 204