Workflow Dispatch
This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow."
Actions
| Action | Sent when |
|---|---|
workflow_dispatch | This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "Manually running a workflow." |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
inputs | object | Yes | |
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 |
ref | string | Yes | |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
sender | object | Yes | A GitHub user. |
workflow | string | Yes |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.