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."

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/orgs//hooks/'

Response Example

200 - Example 1

{
    "active": true,
    "config": {
        "content_type": "\"form\"",
        "insecure_ssl": "\"0\"",
        "secret": "\"********\"",
        "url": "\"http://example.com/2\""
    },
    "created_at": "2011-09-06T17:26:27.000Z",
    "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries",
    "events": [
        "push",
        "pull_request"
    ],
    "id": 1,
    "name": "web",
    "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings",
    "type": "string",
    "updated_at": "2011-09-06T20:39:23.000Z",
    "url": "https://api.github.com/orgs/octocat/hooks/1"
}

Request

Path Params

org

string

required

The organization name. The name is not case sensitive.

hook_id

integer

required

The unique identifier of the hook.

Responses

🟢200Response

application/json

Body

Org Hook

active

boolean

required

Example:

true

config

object

required

content_type

string

optional

Example:

"form"

insecure_ssl

string

optional

Example:

"0"

secret

string

optional

Example:

"********"

url

string

optional

Example:

"http://example.com/2"

created_at

string <date-time>

required

Example:

2011-09-06T17:26:27.000Z

deliveries_url

string <uri>

optional

Example:

https://api.github.com/orgs/octocat/hooks/1/deliveries

events

array[string]

required

Example:

["push","pull_request"]

integer

required

Example:

name

string

required

Example:

web

ping_url

string <uri>

required

Example:

https://api.github.com/orgs/octocat/hooks/1/pings

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/orgs/octocat/hooks/1

🟠404404

Modified at 2023-08-15 02:59:28

Delete an organization webhook

Update an organization webhook