Create a repository webhook

Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can
share the same config as long as those webhooks do not have any events that overlap.

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

{ "active": true, "config": { "content_type": "\"json\"", "digest": "\"sha256\"", "email": "\"foo@bar.com\"", "insecure_ssl": "\"0\"", "password": "\"foo\"", "room": "\"roomer\"", "secret": "\"********\"", "subdomain": "\"foo\"", "token": "\"abc\"", "url": "https://example.com/webhook" }, "created_at": "2011-09-06T17:26:27Z", "events": [ "push", "pull_request" ], "id": 42, "last_response": { "code": 0, "message": "string", "status": "string" }, "name": "web", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/1/test", "type": "string", "updated_at": "2011-09-06T20:39:23Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1" }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

owner

string

必需

repo

string

必需

Body 参数application/json

object | null

可选

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"

digest

string

可选

示例值:

"sha256"

insecure_ssl

webhook-config-insecure-ssl

可选

secret

string

可选

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

示例值:

"********"

token

string

可选

示例值:

"abc"

url

string <uri>

可选

The URL to which the payloads will be delivered.

示例值:

https://example.com/webhook

events

array[string]

可选

Determines what events the hook is triggered for.

默认值:

push

name

string

可选

Use web to create a webhook. Default: web. This parameter only accepts the value web.

示例

返回响应

🟢201Response

application/json

Body

Webhooks for repositories.

active

boolean

必需

Determines whether the hook is actually triggered on pushes.

示例值:

true

config

object

必需

content_type

string

可选

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

示例值:

"json"

digest

string

可选

示例值:

"sha256"

string

可选

示例值:

"foo@bar.com"

insecure_ssl

webhook-config-insecure-ssl

可选

password

string

可选

示例值:

"foo"

room

string

可选

示例值:

"roomer"

secret

string

可选

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

示例值:

"********"

subdomain

string

可选

示例值:

"foo"

token

string

可选

示例值:

"abc"

url

string <uri>

可选

The URL to which the payloads will be delivered.

示例值:

https://example.com/webhook

created_at

string <date-time>

必需

示例值:

2011-09-06T17:26:27Z

events

array[string]

必需

Determines what events the hook is triggered for. Default: ['push'].

示例值:

["push","pull_request"]

integer

必需

Unique identifier of the webhook.

示例值:

last_response

object (Hook Response)

必需

code

integer | null

必需

message

string | null

必需

status

string | null

必需

name

string

必需

The name of a valid service, use 'web' for a webhook.

示例值:

web

ping_url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World/hooks/1/pings

test_url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World/hooks/1/test

type

string

必需

updated_at

string <date-time>

必需

示例值:

2011-09-06T20:39:23Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World/hooks/1

🟠403403

🟠404404

🟠422422