Skip to content
forgit api docs

Get an organization webhook

GET
/orgs/{org}/hooks/{hook_id}

Returns a webhook configured in an organization. To get only the webhook config properties, see “Get a webhook configuration for an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

hook_id
required
integer

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

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Org Hook

Org Hook

object
id
required
integer
url
required
string format: uri
ping_url
required
string format: uri
deliveries_url
string format: uri
name
required
string
events
required
Array<string>
active
required
boolean
config
required
object
url
string
insecure_ssl
string
content_type
string
secret
string
updated_at
required
string format: date-time
created_at
required
string format: date-time
type
required
string
Examples
Example default 
{
  "id": 1,
  "url": "https://api.github.com/orgs/octocat/hooks/1",
  "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
  "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries",
  "name": "web",
  "events": [
    "push",
    "pull_request"
  ],
  "active": true,
  "config": {
    "url": "http://example.com",
    "content_type": "json"
  },
  "updated_at": "2011-09-06T20:39:23Z",
  "created_at": "2011-09-06T17:26:27Z",
  "type": "Organization"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}