workflow_run event sample json is missing workflow_run and workflow properties #13951
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
The sample json is incomplete.
The documentation above says:
Webhook payload object
| Key | Type | Description | Included in example json |
|---|---|---|---|
| action | string | The action that was performed. Can be one of requested or completed. | ✔️ |
| workflow_run | object | The workflow run. Many workflow_run keys, such as head_branch, conclusion, and pull_requests are the same as those in a check_suite object. | ❌ |
| workflow | object | The workflow that generated the workflow run. | ❌ |
| organization | object | Webhook payloads contain the organization object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization. | ✔️ |
| repository | object | The repository where the event occurred. | ✔️ |
| sender | object | The user that triggered the event. | ✔️ |
Here's a pretty collapsed view of the current JSON:
Additional information
I think #2767 added the referenced documentation.
If the sample json has multiple shapes, then it'd be nice if there were multiple examples of the distinct shapes, or at least some pointers explaining how someone could imagine the other shapes.