List repository webhooks - GitHub v3 REST API

Lists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.

[ { "active": true, "config": { "content_type": "\"json\"", "digest": "\"sha256\"", "email": "\"foo@bar.com\"", "insecure_ssl": "\"0\"", "password": "\"foo\"", "room": "\"roomer\"", "secret": "\"********\"", "subdomain": "\"foo\"", "token": "\"abc\"", "url": "https://example.com/webhook" }, "created_at": "2011-09-06T17:26:27.000Z", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries", "events": [ "push", "pull_request" ], "id": 42, "last_response": { "code": 0, "message": "string", "status": "string" }, "name": "web", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/test", "type": "string", "updated_at": "2011-09-06T20:39:23.000Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1" } ]

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.

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

array of:

active

boolean

required

Determines whether the hook is actually triggered on pushes.

Example:

true

config

object

required

content_type

string

optional

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

Example:

"json"

digest

string

optional

Example:

"sha256"

string

optional

Example:

"foo@bar.com"

insecure_ssl

webhook-config-insecure-ssl

optional

password

string

optional

Example:

"foo"

room

string

optional

Example:

"roomer"

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:

"********"

subdomain

string

optional

Example:

"foo"

token

string

optional

Example:

"abc"

url

string <uri>

optional

The URL to which the payloads will be delivered.

Example:

https://example.com/webhook

created_at

string <date-time>

required

Example:

2011-09-06T17:26:27.000Z

deliveries_url

string <uri>

optional

Example:

https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries

events

array[string]

required

Determines what events the hook is triggered for. Default: ['push'].

Example:

["push","pull_request"]

integer

required

Unique identifier of the webhook.

Example:

last_response

object (Hook Response)

required

code

integer | null

required

message

string | null

required

status

string | null

required

name

string

required

The name of a valid service, use 'web' for a webhook.

Example:

web

ping_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/hooks/1/pings

test_url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/hooks/1/test

type

string

required

updated_at

string <date-time>

required

Example:

2011-09-06T20:39:23.000Z

url

string <uri>

required

Example:

https://api.github.com/repos/octocat/Hello-World/hooks/1

🟠404404