Create a global webhook

curl --location --request POST 'https://api.github.com/admin/hooks' \ --header 'accept;' \ --header 'Content-Type: application/json' \ --data-raw '{ "config": { "content_type": "json", "secret": "secret", "url": "https://example.com/webhook" }, "events": [ "organization", "user" ], "name": "web" }'

{ "active": true, "config": { "content_type": "string", "insecure_ssl": "string", "secret": "string", "url": "string" }, "created_at": "string", "events": [ "string" ], "id": 0, "name": "string", "ping_url": "string", "type": "string", "updated_at": "string", "url": "string" }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Header 参数

string

必需

This API is under preview and subject to change.

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.

content_type

string

可选

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

insecure_ssl

string

可选

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

secret

string

可选

If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

url

string

必需

The URL to which the payloads will be delivered.

events

array[string]

可选

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

name

string

必需

Must be passed as "web".

示例

返回响应

🟢201Response

application/json

Body

active

boolean

可选

config

object

可选

content_type

string

可选

insecure_ssl

string

可选

secret

string

可选

url

string

可选

created_at

string

可选

events

array[string]

可选

integer

可选

name

string

可选

ping_url

string

可选

type

string

可选

updated_at

string

可选

url

string

可选