Add documentation for workflow_run event payload properties

[rebwill]

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?

https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_run

What part(s) of the article would you like to see updated?

The workflow_run event payload documentation is lacking any reference for the workflow_run object.

About two weeks ago, I briefly saw a dropdown here under the workflow_run object. The dropdown was similar to what appears under the dropdown properties of workflow_job.deployment. However the workflow_run dropdown disappeared the next time I reloaded the page, and I have not seen it again. I tried in Firefox and Chrome in case it was a browser issue, but no luck. In the attached screenshot you can see a blank space at the bottom, below the workflow_run body parameter.

I have not been able to find an official (or even unofficial!) documentation for what the workflow_run event payload contains. This has made what should have been a simple use case (a Slack integration for notifications for failed workflow runs) rather frustrating. I've seen a few issues related to this topic. In #23257 I was encouraged to open a new issue for this specifically.

Expected outcome:
Detailed documentation of the properties that the workflow_run event payload object contains.

Additional information

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[cmwilson21]

👋 @rebwill - Thanks for opening the issue! ✨

I'll get this triaged for review! ⚡

Thank you for your interest in improving GitHub Docs! 💖

[docs-bot]

Thank you for opening this issue! Updates to the REST API, GraphQL API, and webhook reference documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.

[cmwilson21]

@rebwill Just a heads up, any changes with the /webhook-events-and-payloads docs have to be made internally. The issue has been transferred and will be reviewed soon ✨

[skedwards88]

Thanks for raising this issue! While we fix this bug, I just want to drop a note that you can find details about this property if you look at the docs for the requested action: https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads?actionType=requested#workflow_run

[rebwill]

Wow, thanks for the heads up @skedwards88, that would explain why I swore I had actually seen the properties before -- it must have actually been at that link you shared.

[rebwill]

An additional piece of data I just noticed:

At the link shared above (https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads?actionType=requested#workflow_run), the workflow_run object only has the dropdown with all of its properties (on Action Type: requested). It does not have the dropdown when Action Type: in_progress or Action Type: completed are selected.