ownerstringrequired
repostringrequired
hook_idintegerrequired
Delete a repository webhook
delete
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/hooks/{hook_id}
Path Parameters
Response
Response
Response
delete/repos/{owner}/{repo}/hooks/{hook_id}
Path Parameters
Get a webhook configuration for a repository
Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use “Get a repository webhook.”
Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/hooks/{hook_id}/config
Path Parameters
ownerstringrequired
repostringrequired
hook_idintegerrequired
Response
200 application/json
Response
200 application/json
Response
Webhook Configuration
Configuration object of the webhook
urlstring(uri)
The URL to which the payloads will be delivered.
Example:https://example.com/webhook
content_typestring
The media type used to serialize the payloads. Supported values include json and form. The default is form.
Example:"json"
secretstring
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Example:"********"
insecure_ssl
One OfVariant 1string
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.
Example:"0"
get/repos/{owner}/{repo}/hooks/{hook_id}/config
Path Parameters
200 application/json
Update a webhook configuration for a repository
Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use “Update a repository webhook.”
Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.
patch
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/hooks/{hook_id}/config
Path Parameters
ownerstringrequired
repostringrequired
hook_idintegerrequired
Body
application/json
Body
application/json
* Additional properties are NOT allowed.
urlstring(uri)
The URL to which the payloads will be delivered.
Example:https://example.com/webhook
content_typestring
The media type used to serialize the payloads. Supported values include json and form. The default is form.
Example:"json"
secretstring
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Example:"********"
insecure_ssl
One OfVariant 1string
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.
Example:"0"
Response
200 application/json
Response
200 application/json
Response
Webhook Configuration
Configuration object of the webhook
urlstring(uri)
The URL to which the payloads will be delivered.
Example:https://example.com/webhook
content_typestring
The media type used to serialize the payloads. Supported values include json and form. The default is form.
Example:"json"
secretstring
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Example:"********"
insecure_ssl
One OfVariant 1string
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.
Example:"0"
patch/repos/{owner}/{repo}/hooks/{hook_id}/config
Path Parameters
Body
{
"content_type": "json",
"insecure_ssl": "0",
"secret": "********",
"url": "https://example.com/webhook"
}
200 application/json
Ping a repository webhook
This will trigger a ping event to be sent to the hook.
post
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/hooks/{hook_id}/pings
Path Parameters
ownerstringrequired
repostringrequired
hook_idintegerrequired
Response
Response
Response
post/repos/{owner}/{repo}/hooks/{hook_id}/pings
Path Parameters
Test the push repository webhook
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
post
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/hooks/{hook_id}/tests
Path Parameters
ownerstringrequired
repostringrequired
hook_idintegerrequired
Response
Response
Response
post/repos/{owner}/{repo}/hooks/{hook_id}/tests