Create an organization webhook

Here's how you can create a hook that posts payloads in JSON format:

curl --location --request POST 'https://api.github.com/orgs//hooks' \ --header 'Content-Type: application/json' \ --data-raw '{ "active": true, "config": { "content_type": "json", "url": "http://example.com/webhook" }, "events": [ "push", "pull_request" ], "name": "web" }'

{ "active": true, "config": { "content_type": "\"form\"", "insecure_ssl": "\"0\"", "secret": "\"********\"", "url": "\"http://example.com/2\"" }, "created_at": "2011-09-06T17:26:27Z", "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:23Z", "url": "https://api.github.com/orgs/octocat/hooks/1" }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

org

string

必需

Body 参数application/json

active

boolean

可选

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

默认值:

true

config

object

必需

Key/value pairs to provide settings for this webhook. These are defined below.

content_type

string

可选

The media type used to serialize the payloads. Supported values include json and form. The default is form.

示例值:

"json"

insecure_ssl

webhook-config-insecure-ssl

可选

password

string

可选

示例值:

"password"

secret

string

可选

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

示例值:

"********"

url

string <uri>

必需

The URL to which the payloads will be delivered.

示例值:

https://example.com/webhook

username

string

可选

示例值:

"kdaigle"

events

array[string]

可选

Determines what events the hook is triggered for.

默认值:

push

name

string

必需

Must be passed as "web".

示例

返回响应

🟢201Response

application/json

Body

Org Hook

active

boolean

必需

示例值:

true

config

object

必需

content_type

string

可选

示例值:

"form"

insecure_ssl

string

可选

示例值:

"0"

secret

string

可选

示例值:

"********"

url

string

可选

示例值:

"http://example.com/2"

created_at

string <date-time>

必需

示例值:

2011-09-06T17:26:27Z

events

array[string]

必需

示例值:

["push","pull_request"]

integer

必需

示例值:

name

string

必需

示例值:

web

ping_url

string <uri>

必需

示例值:

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

type

string

必需

updated_at

string <date-time>

必需

示例值:

2011-09-06T20:39:23Z

url

string <uri>

必需

示例值:

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

🟠404404

🟠422422