This page was generated based on Github’s Documentation. See our welcome page for context and details.

Github Event page_build #

Github Action Trigger #


Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
page_buildNot applicableLast commit on default branchNot applicable

Note: This event will only trigger a workflow run if the workflow file is on the default branch.

Runs your workflow when someone pushes to a branch that is the publishing source for GitHub Pages, if GitHub Pages is enabled for the repository. For more information about GitHub Pages publishing sources, see “Configuring a publishing source for your GitHub Pages site.” For information about the REST API, see “REST API endpoints for repositories.”

For example, you can run a workflow when the page_build event occurs.


Event Payload #


This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "Configuring a publishing source for your GitHub Pages site." For information about the API to manage GitHub Pages, see "Pages" in the REST API documentation.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.


The List GitHub Pages builds itself. or nullrequired or nullrequired or nullrequired or nulloptional, User, Organizationoptional

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured on an enterprise account or an organization that’s part of an enterprise account. For more information, see “About enterprise accounts."


The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."


A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.


The repository on GitHub where the event occurred. Webhook payloads contain the repository property when the event occurs from activity in a repository.


The GitHub user that triggered the event. This property is included in every webhook payload.