Text of docs.github.com › en › actions › reference › workflows-and-actions › events-that-trigge… as Styx crawled it on Nov 20, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Events that trigger workflows - GitHub Docs

Skip to main content Skip to content Collapse sidebar Expand sidebar Events that trigger workflows You can configure your workflows to run when specific activity on GitHub happens, at a scheduled time, or when an event outside of GitHub occurs. In this article About events that trigger workflows Workflow triggers are events that cause a workflow to run. For more information about how to use workflow triggers, see Triggering a workflow .

Some events have multiple activity types. For these events, you can specify which activity types will trigger a workflow run. For more information about what each activity type means, see Webhook events and payloads . Note Not all webhook events trigger workflows. Like GitHub Actions workflows, agentic workflows can be triggered by repository events and schedules. For an example, see Creating GitHub Agentic Workflows . branch_protection_rule Webhook event payload Activity types GITHUB_SHA GITHUB_REF branch_protection_ rule - created - edited - deleted Last commit on default branch Default branch Note More than one activity type triggers this event.

For information about each activity type, see Webhook events and payloads . By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see Workflow syntax for GitHub Actions . This event will only trigger a workflow run if the workflow file exists on the default branch. Runs your workflow when branch protection rules in the workflow repository are changed.

For more information about branch protection rules, see About protected branches . For information about the branch protection rule APIs, see Branches in the GraphQL API documentation or REST API endpoints for branches and their settings . For example, you can run a workflow when a branch protection rule has been created or deleted : on: branch_protection_rule: types: [ created , deleted ] 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 Note More than one activity type triggers this event.

For information about each activity type, see Webhook events and payloads . By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see Workflow syntax for GitHub Actions . This event will only trigger a workflow run if the workflow file exists on the default branch. To prevent recursive workflows, this event does not trigger workflows if the check run's check suite was created by GitHub Actions or if the check suite's head SHA is associated with GitHub Actions.

Runs your workflow when activity related to a check run occurs. A check run is an individual test that is part of a check suite. For information, see Using the REST API to interact with checks . For information about the check run APIs, see Checks in the GraphQL API documentation or REST API endpoints for check runs . For example, you can run a workflow when a check run has been rerequested or completed . on: check_run: types: [ rerequested , completed ] check_suite Webhook event payload Activity types GITHUB_SHA GITHUB_REF check_suite - completed Last commit on default branch Default branch Note More than one activity type triggers this event.

For information about each activity type, see Webhook events and payloads . Although only the completed activity type is supported, specifying the activity type will keep your workflow specific if more activity types are added in the future. By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see Workflow syntax for GitHub Actions .

This event will only trigger a workflow run if the workflow file exists on the default branch. To prevent recursive workflows, this event does not trigger workflows if the check suite was created by GitHub Actions or if the check suite's head SHA is associated with GitHub Actions. Runs your workflow when check suite activity occurs. A check suite is a collection of the check runs created for a specific commit. Check suites summarize the status and conclusion of the check runs that are in the suite.

For information, see Using the REST API to interact with checks . For information about the check suite APIs, see Checks in the GraphQL API documentation or REST API endpoints for check suites . For example, you can run a workflow when a check suite has been completed . on: check_suite: types: [ completed ] create Webhook event payload Activity types GITHUB_SHA GITHUB_REF create Not applicable Last commit on the created branch or tag Branch or tag created Note An event will not be created when you create more than three tags at once.

Runs your workflow when someone creates a Git reference (Git branch or tag) in the workflow's repository. For information about the APIs to create a Git reference, see Git in the GraphQL API documentation or REST API endpoints for Git references . For example, you can run a workflow when the create event occurs. on: create delete Webhook event payload Activity types GITHUB_SHA GITHUB_REF delete Not applicable Last commit on default branch Default branch Note This event will only trigger a workflow run if the workflow file exists on the default branch.

An event will not be created when you delete more than three tags at once. Runs your workflow when someone deletes a Git reference (Git branch or tag) in the workflow's repository. For information about the APIs to delete a Git reference, see Git in the GraphQL API documentation or REST API endpoints for Git references . For example, you can run a workflow when the delete event occurs. on: delete deployment Webhook event payload Activity types GITHUB_SHA GITHUB_REF deployment Not applicable Commit to be deployed Branch or tag to be deployed (empty if created with a commit SHA) Runs your workflow when someone creates a deployment in the workflow's repository.

Deployments created with a commit SHA may not have a Git ref. For information about the APIs to create a deployment, see Deployments in the GraphQL API documentation or REST API endpoints for repositories . For example, you can run a workflow when the deployment event occurs. on: deployment deployment_status Webhook event payload Activity types GITHUB_SHA GITHUB_REF deployment_status Not applicable Commit to be deployed Branch or tag to be deployed (empty if commit) Note When a deployment status's state is set to inactive , a workflow run will not be triggered.

Runs your workflow when a third party provides a deployment status. Deployments created with a commit SHA may not have a Git ref. For information about the APIs to create a deployment status, see Deployments in the GraphQL API documentation or REST API endpoints for deployments . For example, you can run a workflow when the deployment_status event occurs. on: deployment_status discussion Webhook event payload Activity types GITHUB_SHA GITHUB_REF discussion - created - edited - deleted - transferred - pinned - unpinned - labeled - unlabeled - locked - unlocked - category_changed - answered - unanswered Last commit on default branch Default branch Note More than one activity type triggers this event.

For information about each activity type, see Webhook events and payloads . By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see Workflow syntax for GitHub Actions . This event will only trigger a workflow run if the workflow file exists on the default branch. Webhook events for GitHub Discussions are currently in public preview and subject to change.

Runs your workflow when a discussion in the workflow's repo

The rest of this page is on the live site.