Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit8058f41

Browse files
committed
add note about hook booleans
1 parent77daa6c commit8058f41

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

‎content/v3/repos/hooks.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,23 @@ part of the open source [github-services](https://github.com/github/github-servi
6060

6161
###Input
6262

63-
name
63+
`name`
6464
:_Required_**string** - The name of the service that is being called.
6565
See[/hooks](https://api.github.com/hooks) for the possible names.
6666

67-
config
67+
`config`
6868
:_Required_**hash** - A Hash containing key/value pairs to provide
6969
settings for this hook. These settings vary between the services and
7070
are defined in the
7171
[github-services](https://github.com/github/github-services) repo.
72+
Booleans are stored internally as "1" for true, and "0" for false. Any
73+
JSON true/false values will be converted automatically.
7274

73-
events
75+
`events`
7476
:_Optional_**array** - Determines what events the hook is triggered
7577
for. Default:`["push"]`.
7678

77-
active
79+
`active`
7880
:_Optional_**boolean** - Determines whether the hook is actually
7981
triggered on pushes.
8082

@@ -97,30 +99,33 @@ triggered on pushes.
9799

98100
###Input
99101

100-
name
102+
`name`
101103
:_Required_**string** - The name of the service that is being called.
102104
See[/hooks](https://api.github.com/hooks) for the possible names.
103105

104-
config
106+
`config`
105107
:_Required_**hash** - A Hash containing key/value pairs to provide
106108
settings for this hook. Modifying this will replace the entire config
107109
object. These settings vary between the services and
108110
are defined in the
109111
[github-services](https://github.com/github/github-services) repo.
112+
Booleans are stored internally as "1" for true, and "0" for false. Any
113+
JSON true/false values will be converted automatically.
110114

111-
events
115+
116+
`events`
112117
:_Optional_**array** - Determines what events the hook is triggered
113118
for. This replaces the entire array of events. Default:`["push"]`.
114119

115-
add_events
120+
`add_events`
116121
:_Optional_**array** - Determines a list of events to be added to the
117122
list of events that the Hook triggers for.
118123

119-
remove_events
124+
`remove_events`
120125
:_Optional_**array** - Determines a list of events to be removed from the
121126
list of events that the Hook triggers for.
122127

123-
active
128+
`active`
124129
:_Optional_**boolean** - Determines whether the hook is actually
125130
triggered on pushes.
126131

@@ -197,17 +202,17 @@ exists, it will be modified according to the request.
197202

198203
###Parameters
199204

200-
hub.mode
205+
`hub.mode`
201206
:_Required_**string** - Either`subscribe` or`unsubscribe`.
202207

203-
hub.topic
208+
`hub.topic`
204209
:_Required_**string** - The URI of the GitHub repository to subscribe
205210
to. The path must be in the format of`/:user/:repo/events/:event`.
206211

207-
hub.callback
212+
`hub.callback`
208213
:_Required_**string** - The URI to receive the updates to the topic.
209214

210-
hub.secret
215+
`hub.secret`
211216
:_Optional_**string** - A shared secret key that generates a SHA1 HMAC
212217
of the payload content. You can verify a push came from GitHub by
213218
comparing the received body with the contents of the`X-Hub-Signature`

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp