Skip to content

Document updatedConfig for webhooks #1628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2025
Merged

Document updatedConfig for webhooks #1628

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/hub/webhooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,32 @@ Newly created references will have `oldSha` set to `null`. Deleted references wi

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

### Config changes

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:

```json
"updatedConfig": {
"private": false
}
```

or

```json
"updatedConfig": {
"xetEnabled": true,
}
```

or, when the updated config key is not supported by the webhook:

```json
"updatedConfig": {}
```

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].

### Discussions and Pull Requests

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:
Expand Down