About events that trigger workflows
Workflow triggers are events that cause a workflow to run.
check_run
| Webhook event payload | Activity types | GITHUB_SHA |
GITHUB_REF |
|---|---|---|---|
check_run |
- created- rerequested- completed- requested_action |
Last commit on default branch | Default branch |
Runs your workflow when activity related to a check run occurs.
fork
| Webhook event payload | Activity types | GITHUB_SHA |
GITHUB_REF |
|---|---|---|---|
fork |
Not applicable | Last commit on default branch | Default branch |
Runs your workflow when someone forks a repository.
repository_dispatch
| Webhook event payload | Activity types | GITHUB_SHA |
GITHUB_REF |
|---|---|---|---|
| repository_dispatch | Custom | Last commit on default branch | Default branch |
You can use the GitHub API to trigger a webhook event called repository_dispatch.