Teile der REST-API-Dokumentation wurden kürzlich an andere Stelle verschoben. Falls du nicht findest, wonach du suchst, kannst du die Aktionen-REST-API-Seite ausprobieren.
Globale Webhooks
Verwende die REST-API, um globale Webhooks für dein Unternehmen zu verwalten.
Informationen zu globalen Webhooks
Diese Endpunkte sind nur für authentifizierte Websiteadministratorinnen verfügbar. Normale Benutzerinnen erhalten eine 404
-Antwort. Eine Anleitung zum Konfigurieren globaler Webhooks findest du unter Informationen zu globalen Webhooks.
Globale Webhooks sind automatisch für dein Unternehmen installiert. Du kannst globale Webhooks verwenden, um automatisch Regeln für Benutzer, Organisationen, Teams und Repositorys in deinem Unternehmen zu überwachen, darauf zu reagieren oder sie zu erzwingen.
Globale Webhooks können die Ereignistypen Organisation, Benutzer, Repository, Team, Mitglied, Mitgliedschaft, Fork und Ping abonnieren.
List global webhooks
Parameter für „List global webhooks“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
per_page integer The number of results per page (max 100). Standard: |
page integer Page number of the results to fetch. Standard: |
HTTP-Antwortstatuscodes für „List global webhooks“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele für „List global webhooks“
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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
Parameter für „Create a global webhook“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
name string ErforderlichMust be passed as "web". | |||||
config object ErforderlichKey/value pairs to provide settings for this webhook. | |||||
Properties of |
Name, type, BESCHREIBUNG |
---|
url string ErforderlichThe URL to which the payloads will be delivered. |
content_type string The media type used to serialize the payloads. Supported values include |
secret string If provided, the |
insecure_ssl string Determines whether the SSL certificate of the host for |
events
array of strings The events that trigger this webhook. A global webhook can be triggered by user
and organization
events. Default: user
and organization
.
active
boolean Determines if notifications are sent when the webhook is triggered. Set to true
to send notifications.
Standard: true
HTTP-Antwortstatuscodes für „Create a global webhook“
Statuscode | BESCHREIBUNG |
---|---|
201 | Created |
Codebeispiele für „Create a global webhook“
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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
Parameter für „Get a global webhook“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
hook_id integer ErforderlichThe unique identifier of the hook. You can find this value in the |
HTTP-Antwortstatuscodes für „Get a global webhook“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele für „Get a global webhook“
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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.
Parameter für „Update a global webhook“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
hook_id integer ErforderlichThe unique identifier of the hook. You can find this value in the |
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
config object Key/value pairs to provide settings for this webhook. | |||||
Properties of |
Name, type, BESCHREIBUNG |
---|
url string ErforderlichThe URL to which the payloads will be delivered. |
content_type string The media type used to serialize the payloads. Supported values include |
secret string If provided, the |
insecure_ssl string Determines whether the SSL certificate of the host for |
events
array of strings The events that trigger this webhook. A global webhook can be triggered by user
and organization
events. Default: user
and organization
.
active
boolean Determines if notifications are sent when the webhook is triggered. Set to true
to send notifications.
Standard: true
HTTP-Antwortstatuscodes für „Update a global webhook“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele für „Update a global webhook“
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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
Parameter für „Delete a global webhook“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
hook_id integer ErforderlichThe unique identifier of the hook. You can find this value in the |
HTTP-Antwortstatuscodes für „Delete a global webhook“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Delete a global webhook“
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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.
Parameter für „Ping a global webhook“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
hook_id integer ErforderlichThe unique identifier of the hook. You can find this value in the |
HTTP-Antwortstatuscodes für „Ping a global webhook“
Statuscode | BESCHREIBUNG |
---|---|
204 | No Content |
Codebeispiele für „Ping a global webhook“
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/admin/hooks/HOOK_ID/pings
Response
Status: 204