Get a webhook configuration for a repository

GET

/repos/{owner}/{repo}/hooks/{hook_id}/config

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///hooks//config'

Response Example

{
    "content_type": "\"json\"",
    "insecure_ssl": "\"0\"",
    "secret": "\"********\"",
    "url": "https://example.com/webhook"
}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

hook_id

integer

required

The unique identifier of the hook.

Responses

🟢200Response

application/json

Body

Configuration object of the webhook

content_type

string

optional

The media type used to serialize the payloads. Supported values include json and form. The default is form.

Example:

"json"

insecure_ssl

webhook-config-insecure-ssl

optional

One of

string

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.

Example:

"0"

secret

string

optional

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

Example:

"********"

url

string <uri>

optional

The URL to which the payloads will be delivered.

Example:

https://example.com/webhook

Modified at 2023-08-15 02:59:29

Update a repository webhook

Update a webhook configuration for a repository