Skip to content

Commit 7d686eb

Browse files
author
Douglas DeMars
authored
Repository webhook documentation improvement (#944)
* provide more detail into configuration block options, use standard doc format for blocks * whitespace at end of file * minor spelling error "of" -> "if"
1 parent 46fcafd commit 7d686eb

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

website/docs/r/repository_webhook.html.markdown

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,22 @@ The following arguments are supported:
4646

4747
* `events` - (Required) A list of events which should trigger the webhook. See a list of [available events](https://developer.github.com/v3/activity/events/types/).
4848

49-
* `configuration` - (Required) key/value pair of configuration for this webhook. Available keys are `url`, `content_type`, `secret` and `insecure_ssl`. `secret` is [the shared secret, see API documentation](https://developer.github.com/v3/repos/hooks/#create-a-hook). `content_type` may be either form or json.
49+
* `configuration` - (Required) Configuration block for the webhook. [Detailed below.](#configuration)
5050

51-
* `active` - (Optional) Indicate of the webhook should receive events. Defaults to `true`.
51+
* `active` - (Optional) Indicate if the webhook should receive events. Defaults to `true`.
5252

5353
* `name` - (Optional) The type of the webhook. `web` is the default and the only option.
5454

55+
### configuration
56+
57+
* `url` - (Required) The URL of the webhook.
58+
59+
* `content_type` - (Required) The content type for the payload. Valid values are either `form` or `json`.
60+
61+
* `secret` - (Optional) The shared secret for the webhook. [See API documentation](https://developer.github.com/v3/repos/hooks/#create-a-hook).
62+
63+
* `insecure_ssl` - (Optional) Insecure SSL boolean toggle. Defaults to `false`.
64+
5565
## Attributes Reference
5666

5767
The following additional attributes are exported:

0 commit comments

Comments
 (0)