Diese Version von GitHub Enterprise Server wird eingestellt am 2026-08-25. Nicht mehr unterstützte Versionen werden nicht unterstützt. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Eine bessere Leistung, verbesserte Sicherheit und neue Features in GitHub Enterprise Server finden Sie unter Overview des Upgradeprozesses. Wenden Sie sich bei Fragen zum Upgrade an den GitHub Enterprise Support.

Die REST-API ist jetzt versioniert. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für GitHub App Webhooks

Verwenden Sie die REST-API, um mit Webhooks für OAuth apps zu interagieren.

Informationen zu Webhooks für GitHub Apps

Ein Webhook von GitHub App ermöglicht es Ihrem Server, HTTP-Datenlasten POST zu empfangen, wenn bestimmte Ereignisse für GitHub App eintreten. Weitere Informationen findest du unter Webhooks-Dokumentation und Verwenden von Webhooks mit GitHub Apps.

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.

Feinkörnige Zugriffstoken für "Get a webhook configuration for an app"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

HTTP-Antwortstatuscodes für "Get a webhook configuration for an app"

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für "Get a webhook configuration for an app"

Anforderungsbeispiel

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" \ http(s)://HOSTNAME/api/v3/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.

Feinkörnige Zugriffstoken für "Update a webhook configuration for an app"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Update a webhook configuration for an app"

Header
accept string

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

Körperparameter
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.

HTTP-Antwortstatuscodes für "Update a webhook configuration for an app"

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für "Update a webhook configuration for an app"

Anforderungsbeispiel

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" \ http(s)://HOSTNAME/api/v3/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.

Feinkörnige Zugriffstoken für "List deliveries for an app webhook"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "List deliveries for an app webhook"

Header
accept string

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

Abfrageparameter
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Standard: 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.

status string

Returns webhook deliveries filtered by delivery outcome classification based on status_code range. A status of success returns deliveries with a status_code in the 200-399 range (inclusive). A status of failure returns deliveries with a status_code in the 400-599 range (inclusive).

Kann eine der folgenden sein: success, failure

HTTP-Antwortstatuscodes für "List deliveries for an app webhook"

StatuscodeBESCHREIBUNG
200

OK

400

Bad Request

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "List deliveries for an app webhook"

Anforderungsbeispiel

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" \ http(s)://HOSTNAME/api/v3/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.

Feinkörnige Zugriffstoken für "Get a delivery for an app webhook"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Get a delivery for an app webhook"

Header
accept string

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

Pfadparameter
delivery_id integer Erforderlich

HTTP-Antwortstatuscodes für "Get a delivery for an app webhook"

StatuscodeBESCHREIBUNG
200

OK

400

Bad Request

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Get a delivery for an app webhook"

Anforderungsbeispiel

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" \ http(s)://HOSTNAME/api/v3/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" } }

Redeliver a delivery for an app webhook

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

You must use a JWT to access this endpoint.

Feinkörnige Zugriffstoken für "Redeliver a delivery for an app webhook"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Redeliver a delivery for an app webhook"

Header
accept string

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

Pfadparameter
delivery_id integer Erforderlich

HTTP-Antwortstatuscodes für "Redeliver a delivery for an app webhook"

StatuscodeBESCHREIBUNG
202

Accepted

400

Bad Request

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für "Redeliver a delivery for an app webhook"

Anforderungsbeispiel

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" \ http(s)://HOSTNAME/api/v3/app/hook/deliveries/DELIVERY_ID/attempts

Accepted

Status: 202