Workflow Run
This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "About workflows." For information about the APIs to manage workflow runs, see the GraphQL documentation or "Workflow runs" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
completed | A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful. |
in-progress | A workflow run started processing on a runner. |
requested | A workflow run was triggered. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | Yes | |
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
sender | object | Yes | A GitHub user. |
workflow | object | Yes | |
workflow_run | object | Yes |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.