REST-API-Endpunkte für GitHub App Webhooks - GitHub Enterprise Cloud Docs
Skip to main content Skip to content Randleiste reduzieren Randleiste erweitern 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" Statuscode BESCHREIBUNG 200 OK Codebeispiele für "Get a webhook configuration for an app" Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com . Anforderungsbeispiel get /app/hook/config In Zwischenablage kopieren curl request example curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ 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. 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 Name, Typ, BESCHREIBUNG accept string Setting to application/vnd.github+json is recommended.
Körperparameter Name, Typ, BESCHREIBUNG 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" Statuscode BESCHREIBUNG 200 OK Codebeispiele für "Update a webhook configuration for an app" Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com .
Anforderungsbeispiel patch /app/hook/config In Zwischenablage kopieren curl request example curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ 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. 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 Name, Typ, BESCHREIBUNG accept string Setting to application/vnd.github+json is recommended.
Abfrageparameter Name, Typ, BESCHREIBUNG 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" Statuscode BESCHREIBUNG 200 OK 400 Bad Request 422 Validation failed, or the endpoint has been spammed. Codebeispiele für "List deliveries for an app webhook" Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com .
Anforderungsbeispiel get /app/hook/deliveries In Zwischenablage kopieren curl request example curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ 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. 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 Name, Typ, BESCHREIBUNG accept string Setting to application/vnd.github+json is recommended.
Pfadparameter Name, Typ, BESCHREIBUNG delivery_id integer Erforderlich HTTP-Antwortstatuscodes für "Get a delivery for an app webhook" Statuscode BESCHREIBUNG 200 OK 400 Bad Request 422 Validation failed, or the endpoint has been spammed. Codebeispiele für "Get a delivery for an app webhook" Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com .
Anforderungsbeispiel get /app /hook /deliveries /{delivery_ id} In Zwischenablage kopieren curl request example curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ 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", "installati
The rest of this page is on the live site.