Skip to main content
Manja / GitHub

List repository webhooks

GET/repos/{owner}/{repo}/hooks
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
Query Parameters
per_page integer
optional

Results per page (max 100)

page integer
optional

Page number of the results to fetch.

Responses

application/json array[Webhook object]

Response

Headers
Link string
Example:
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
items Webhook object

Webhooks for repositories.

active boolean
required

Determines whether the hook is actually triggered on pushes.

Example: true

config object
required
content_type webhook-config-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"

email string
optional

Example: "[email protected]"

insecure_ssl webhook-config-insecure-ssl
optional
password string
optional

Example: "foo"

room string
optional

Example: "roomer"

secret webhook-config-secret string
optional

If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/[email protected]/webhooks/event-payloads/#delivery-headers).

Example: "********"

subdomain string
optional

Example: "foo"

token string
optional

Example: "abc"

url webhook-config-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:27Z

events array[string]
required

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

Example:
[
  "push",
  "pull_request"
]
id integer
required

Unique identifier of the webhook.

Example: 42

last_response Hook Response object
required
code integer
requirednullable
message string
requirednullable
status string
requirednullable
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:23Z

url string<uri>
required

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

application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional