Skip to content

Commit 9a3b522

Browse files
authored
Document payload (#1628)
1 parent 377c66a commit 9a3b522

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/hub/webhooks.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,32 @@ Newly created references will have `oldSha` set to `null`. Deleted references wi
158158

159159
You can react to new commits on specific pull requests, new tags, or new branches.
160160

161+
### Config changes
162+
163+
When the top-level property `event.scope` is `"repo.config"`, the `updatedConfig` property is specified. It is an object containing the updated config. Here is an example value:
164+
165+
```json
166+
"updatedConfig": {
167+
"private": false
168+
}
169+
```
170+
171+
or
172+
173+
```json
174+
"updatedConfig": {
175+
"xetEnabled": true,
176+
}
177+
```
178+
179+
or, when the updated config key is not supported by the webhook:
180+
181+
```json
182+
"updatedConfig": {}
183+
```
184+
185+
For now only `private` and `xetEnabled` are supported. If you would benefit from more config keys being present here, please let us know at [email protected].
186+
161187
### Discussions and Pull Requests
162188

163189
The top-level property `discussion` is specified on community events (discussions and Pull Requests). The `discussion.isPullRequest` property is a boolean indicating if the discussion is also a Pull Request (on the Hub, a PR is a special type of discussion). Here is an example value:

0 commit comments

Comments
 (0)