Sign in

v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-01-0382859610.0 MB
repos

Get a repository webhook

Returns a webhook configured in a repository. To get only the webhook config properties, see "Get a webhook configuration for a repository."

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

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.

hook_idinteger required

The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID header of a webhook delivery.

Response

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": {
    "email": "\"foo@bar.com\"",
    "password": "\"foo\"",
    "room": "\"roomer\"",
    "subdomain": "\"foo\"",
    "url": "https://example.com/webhook",
    "insecure_ssl": "\"0\"",
    "content_type": "\"json\"",
    "digest": "\"sha256\"",
    "secret": "\"********\"",
    "token": "\"abc\""
  },
  "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"
}