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 payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`page_build`	Not applicable	Last commit on default branch	Not 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.

on:
  page_build

Event Payload #

source

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.

field	type	required	description
`github.event.build`	object	required	The List GitHub Pages builds itself.
`github.event.build.commit`	string or null	required
`github.event.build.created_at`	string	required
`github.event.build.duration`	integer	required
`github.event.build.error`	object	required
`github.event.build.error.message`	string or null	required
`github.event.build.pusher`	object or null	required
`github.event.build.pusher.avatar_url`	string	optional
`github.event.build.pusher.deleted`	boolean	optional
`github.event.build.pusher.email`	string or null	optional
`github.event.build.pusher.events_url`	string	optional
`github.event.build.pusher.followers_url`	string	optional
`github.event.build.pusher.following_url`	string	optional
`github.event.build.pusher.gists_url`	string	optional
`github.event.build.pusher.gravatar_id`	string	optional
`github.event.build.pusher.html_url`	string	optional
`github.event.build.pusher.id`	integer	required
`github.event.build.pusher.login`	string	required
`github.event.build.pusher.name`	string	optional
`github.event.build.pusher.node_id`	string	optional
`github.event.build.pusher.organizations_url`	string	optional
`github.event.build.pusher.received_events_url`	string	optional
`github.event.build.pusher.repos_url`	string	optional
`github.event.build.pusher.site_admin`	boolean	optional
`github.event.build.pusher.starred_url`	string	optional
`github.event.build.pusher.subscriptions_url`	string	optional
`github.event.build.pusher.type`	`Bot`, `User`, `Organization`	optional
`github.event.build.pusher.url`	string	optional
`github.event.build.status`	string	required
`github.event.build.updated_at`	string	required
`github.event.build.url`	string	required
`github.event.enterprise`	object	optional	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."
`github.event.id`	integer	required
`github.event.installation`	object	optional	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."
`github.event.organization`	object	optional	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.
`github.event.repository`	object	required	The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository.
`github.event.sender`	object	required	The GitHub user that triggered the event. This property is included in every webhook payload.

Github Event page_build #

Github Action Trigger #

Event Payload #

Github Event `page_build` #