Skip to content

Add documentation for workflow_run event payload properties #26319

Description

@rebwill

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

image

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamwaiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions