@@ -60,21 +60,23 @@ part of the open source [github-services](https://github.com/github/github-servi
60
60
61
61
###Input
62
62
63
- name
63
+ ` name `
64
64
:_ Required_ ** string** - The name of the service that is being called.
65
65
See[ /hooks] ( https://api.github.com/hooks ) for the possible names.
66
66
67
- config
67
+ ` config `
68
68
:_ Required_ ** hash** - A Hash containing key/value pairs to provide
69
69
settings for this hook. These settings vary between the services and
70
70
are defined in the
71
71
[ 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.
72
74
73
- events
75
+ ` events `
74
76
:_ Optional_ ** array** - Determines what events the hook is triggered
75
77
for. Default:` ["push"] ` .
76
78
77
- active
79
+ ` active `
78
80
:_ Optional_ ** boolean** - Determines whether the hook is actually
79
81
triggered on pushes.
80
82
@@ -97,30 +99,33 @@ triggered on pushes.
97
99
98
100
###Input
99
101
100
- name
102
+ ` name `
101
103
:_ Required_ ** string** - The name of the service that is being called.
102
104
See[ /hooks] ( https://api.github.com/hooks ) for the possible names.
103
105
104
- config
106
+ ` config `
105
107
:_ Required_ ** hash** - A Hash containing key/value pairs to provide
106
108
settings for this hook. Modifying this will replace the entire config
107
109
object. These settings vary between the services and
108
110
are defined in the
109
111
[ 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.
110
114
111
- events
115
+
116
+ ` events `
112
117
:_ Optional_ ** array** - Determines what events the hook is triggered
113
118
for. This replaces the entire array of events. Default:` ["push"] ` .
114
119
115
- add_events
120
+ ` add_events `
116
121
:_ Optional_ ** array** - Determines a list of events to be added to the
117
122
list of events that the Hook triggers for.
118
123
119
- remove_events
124
+ ` remove_events `
120
125
:_ Optional_ ** array** - Determines a list of events to be removed from the
121
126
list of events that the Hook triggers for.
122
127
123
- active
128
+ ` active `
124
129
:_ Optional_ ** boolean** - Determines whether the hook is actually
125
130
triggered on pushes.
126
131
@@ -197,17 +202,17 @@ exists, it will be modified according to the request.
197
202
198
203
###Parameters
199
204
200
- hub.mode
205
+ ` hub.mode `
201
206
:_ Required_ ** string** - Either` subscribe ` or` unsubscribe ` .
202
207
203
- hub.topic
208
+ ` hub.topic `
204
209
:_ Required_ ** string** - The URI of the GitHub repository to subscribe
205
210
to. The path must be in the format of` /:user/:repo/events/:event ` .
206
211
207
- hub.callback
212
+ ` hub.callback `
208
213
:_ Required_ ** string** - The URI to receive the updates to the topic.
209
214
210
- hub.secret
215
+ ` hub.secret `
211
216
:_ Optional_ ** string** - A shared secret key that generates a SHA1 HMAC
212
217
of the payload content. You can verify a push came from GitHub by
213
218
comparing the received body with the contents of the` X-Hub-Signature `