repos

List repository webhooks

Changed on Jan 12, 2024

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

get/repos/{owner}/{repo}/hooks

Request

Base URL: http://HOSTNAME/api/v3
URL: http://HOSTNAME/api/v3/repos/{owner}/{repo}/hooks
Auth: none declared

Path parameters

ownerstring required

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

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

Query parameters

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

typestring required

idinteger required

Unique identifier of the webhook.

namestring required

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

activeboolean required

Determines whether the hook is actually triggered on pushes.

eventsstring[] required

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

updated_atstring date-time required

created_atstring date-time required

urlstring uri required

test_urlstring uri required

ping_urlstring uri required

deliveries_urlstring uri

Example response

[
  {
    "id": 42,
    "name": "web",
    "active": true,
    "events": [
      "push",
      "pull_request"
    ],
    "config": {
      "url": "https://example.com/webhook",
      "content_type": "\"json\"",
      "secret": "\"********\"",
      "insecure_ssl": "\"0\""
    },
    "updated_at": "2011-09-06T20:39:23Z",
    "created_at": "2011-09-06T17:26:27Z",
    "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1",
    "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/test",
    "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings",
    "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries"
  }
]

Changes

Jan 12, 20243.8318bb91036db Revision changes
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status

Operation history