Create a global webhook
post
http://HOSTNAME/api/v3/admin/hooks
Headers
acceptstringrequired
This API is under preview and subject to change.
Default:application/vnd.github.superpro-preview+json
Body
application/json
Body
application/json
namestringrequired
Must be passed as “web”.
configobjectrequired
Key/value pairs to provide settings for this webhook.
Show Child Parameters
eventsarray[string]
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
Response
201 application/json
Response
201 application/json
Response
global-hook
typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
post/admin/hooks
Headers
Body
{
"name": "web",
"events": [
"organization",
"user"
],
"config": {
"url": "https://example.com/webhook",
"content_type": "json",
"secret": "secret"
}
}
201 application/json
Get a global webhook
get
http://HOSTNAME/api/v3/admin/hooks/{hook_id}
Path Parameters
hook_idintegerrequired
Headers
acceptstringrequired
This API is under preview and subject to change.
Default:application/vnd.github.superpro-preview+json
Response
200 application/json
Response
200 application/json
Response
global-hook
typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
get/admin/hooks/{hook_id}
Path Parameters
Headers
200 application/json
Update a global webhook
Parameters that are not provided will be overwritten with the default value or removed if no default exists.
patch
http://HOSTNAME/api/v3/admin/hooks/{hook_id}
Path Parameters
hook_idintegerrequired
Headers
acceptstringrequired
This API is under preview and subject to change.
Default:application/vnd.github.superpro-preview+json
Body
application/json
Body
application/json
configobject
Key/value pairs to provide settings for this webhook.
Show Child Parameters
eventsarray[string]
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
Response
200 application/json
Response
200 application/json
Response
global-hook-2
typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
patch/admin/hooks/{hook_id}
Path Parameters
Headers
Body
{
"events": [
"organization"
],
"config": {
"url": "https://example.com/webhook"
}
}
200 application/json
Delete a global webhook
delete
http://HOSTNAME/api/v3/admin/hooks/{hook_id}
Path Parameters
hook_idintegerrequired
Headers
acceptstringrequired
This API is under preview and subject to change.
Default:application/vnd.github.superpro-preview+json
Response
204
Response
204
Response
delete/admin/hooks/{hook_id}
Path Parameters
Headers
204
Ping a global webhook
This will trigger a ping event to be sent to the webhook.
post
http://HOSTNAME/api/v3/admin/hooks/{hook_id}/pings
Path Parameters
hook_idintegerrequired
Headers
acceptstringrequired
This API is under preview and subject to change.
Default:application/vnd.github.superpro-preview+json
Response
204
Response
204
Response
post/admin/hooks/{hook_id}/pings
Path Parameters
Headers
204