Workflow Job
This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "Using jobs in a workflow." For information about the API to manage workflow jobs, see "Workflow jobs" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
completed | A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful. |
in-progress | A job in a workflow run started processing on a runner. |
queued | A job in a workflow run was created. |
waiting | A job in a workflow run was created and is waiting for approvals. |
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_job | object | Yes | |
deployment | object | No | A request for a specific ref(branch,sha,tag) to be deployed |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.