Skip to main content
Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.
Enterprise Server 3.1
Español
� 
REST API
Enterprise Server 3.1
Español

� 

Esta versión de GitHub Enterprise se discontinuó el 2022-06-03. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener un mejor desempeño, más seguridad y nuevas características, actualiza a la última versión de GitHub Enterprise. Para obtener ayuda con la actualización, contacta al soporte de GitHub Enterprise.

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.

Repository Webhooks

List repository webhooks

Funciona con GitHub Apps

Parámetros

Encabezados
acceptstring

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

Parámetros de ruta
ownerstringRequerido

The account owner of the repository. The name is not case sensitive.

repostringRequerido

The name of the repository. The name is not case sensitive.

Parámetros de consulta
per_pageinteger

The number of results per page (max 100).

Predeterminado: 30

pageinteger

Page number of the results to fetch.

Predeterminado: 1

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

404

Resource not found

Ejemplos de código

get/repos/{owner}/{repo}/hooks
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks

Response

Status: 200
[ { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "last_response": { "code": null, "status": "unused", "message": null } } ]

Create a repository webhook

Funciona con GitHub Apps

Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

Parámetros

Encabezados
acceptstring

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

Parámetros de ruta
ownerstringRequerido

The account owner of the repository. The name is not case sensitive.

repostringRequerido

The name of the repository. The name is not case sensitive.

Parámetros de cuerpo
namestring

Use web to create a webhook. Default: web. This parameter only accepts the value web.

configobject

Key/value pairs to provide settings for this webhook. These are defined below.

urlstring

The URL to which the payloads will be delivered.

content_typestring

The media type used to serialize the payloads. Supported values include json and form. The default is form.

secretstring

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

insecure_sslstring or number or

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.

tokenstring
digeststring
eventsarray of strings

Determines what events the hook is triggered for.

Predeterminado: push

activeboolean

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

Predeterminado: true

Códigos de estado de respuesta HTTP

Código de estadoDescripción
201

Created

403

Forbidden

404

Resource not found

422

Validation failed

Ejemplos de código

post/repos/{owner}/{repo}/hooks
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks \ -d '{"name":"web","active":true,"events":["push","pull_request"],"config":{"url":"https://example.com/webhook","content_type":"json","insecure_ssl":"0"}}'

Response

Status: 201
{ "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "last_response": { "code": null, "status": "unused", "message": null } }

Get a repository webhook

Funciona con GitHub Apps

Returns a webhook configured in a repository. To get only the webhook config properties, see "Get a webhook configuration for a repository."

Parámetros

Encabezados
acceptstring

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

Parámetros de ruta
ownerstringRequerido

The account owner of the repository. The name is not case sensitive.

repostringRequerido

The name of the repository. The name is not case sensitive.

hook_idintegerRequerido

The unique identifier of the hook.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

404

Resource not found

Ejemplos de código

get/repos/{owner}/{repo}/hooks/{hook_id}
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID

Response

Status: 200
{ "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "last_response": { "code": null, "status": "unused", "message": null } }

Update a repository webhook

Funciona con GitHub Apps

Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for a repository."

Parámetros

Encabezados
acceptstring

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

Parámetros de ruta
ownerstringRequerido

The account owner of the repository. The name is not case sensitive.

repostringRequerido

The name of the repository. The name is not case sensitive.

hook_idintegerRequerido

The unique identifier of the hook.

Parámetros de cuerpo
configobject

Key/value pairs to provide settings for this webhook. These are defined below.

urlstringRequerido

The URL to which the payloads will be delivered.

content_typestring

The media type used to serialize the payloads. Supported values include json and form. The default is form.

secretstring

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

insecure_sslstring or number or

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.

addressstring
roomstring
eventsarray of strings

Determines what events the hook is triggered for. This replaces the entire array of events.

Predeterminado: push

add_eventsarray of strings

Determines a list of events to be added to the list of events that the Hook triggers for.

remove_eventsarray of strings

Determines a list of events to be removed from the list of events that the Hook triggers for.

activeboolean

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

Predeterminado: true

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

404

Resource not found

422

Validation failed

Ejemplos de código

patch/repos/{owner}/{repo}/hooks/{hook_id}
curl \ -X PATCH \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID \ -d '{"active":true,"add_events":["pull_request"]}'

Response

Status: 200
{ "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "last_response": { "code": null, "status": "unused", "message": null } }

Delete a repository webhook

Funciona con GitHub Apps

Parámetros

Encabezados
acceptstring

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

Parámetros de ruta
ownerstringRequerido

The account owner of the repository. The name is not case sensitive.

repostringRequerido

The name of the repository. The name is not case sensitive.

hook_idintegerRequerido

The unique identifier of the hook.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

No Content

404

Resource not found

Ejemplos de código

delete/repos/{owner}/{repo}/hooks/{hook_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID

Response

Status: 204

Ping a repository webhook

Funciona con GitHub Apps

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

Parámetros

Encabezados
acceptstring

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

Parámetros de ruta
ownerstringRequerido

The account owner of the repository. The name is not case sensitive.

repostringRequerido

The name of the repository. The name is not case sensitive.

hook_idintegerRequerido

The unique identifier of the hook.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

No Content

404

Resource not found

Ejemplos de código

post/repos/{owner}/{repo}/hooks/{hook_id}/pings
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/pings

Response

Status: 204

Test the push repository webhook

Funciona con GitHub Apps

This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

Note: Previously /repos/:owner/:repo/hooks/:hook_id/test

Parámetros

Encabezados
acceptstring

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

Parámetros de ruta
ownerstringRequerido

The account owner of the repository. The name is not case sensitive.

repostringRequerido

The name of the repository. The name is not case sensitive.

hook_idintegerRequerido

The unique identifier of the hook.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

No Content

404

Resource not found

Ejemplos de código

post/repos/{owner}/{repo}/hooks/{hook_id}/tests
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/hooks/HOOK_ID/tests

Response

Status: 204