kind:change

title:Page Build Event for Webhooks

created_at:2014-3-12

author_name:benbalter

We've made it even easier to track the status of your[GitHub Pages](http://pages.github.com/) builds. By subscribing to the new[`page_build`](/v3/activity/events/types/#pagebuildevent) event, your application will receive an event payload containing the results of each build. (As always, these builds occur automatically following each push to a GitHub Pages-enabled branch.)

If you have a[webhook](/webhooks/) with the["send me everything" option](https://github.com/blog/1778-webhooks-level-up) selected (or if you use the "[wildcard event](/changes/2014-02-24-wildcard-event-for-webhooks/)" via the API), you will receive the`page_build` event after the next build of your GitHub Pages site. Alternatively, if you prefer to subscribe to specific event types, you can add to the new`page_build` event to your webhooks via your repository's webhook settings page or via the[webhooks API](/v3/repos/hooks/).

For more information, be sure to check out our guide on[working with webhooks](/webhooks/). If you have any questions or feedback, please[drop us a line][contact].

[contact]:https://github.com/contact?form%5Bsubject%5D=API+Page+Build+Event

Key | Type | Description

----|------|-------------

`action`|`string` | The action that was performed. Currently, can only be`started`.

Represents an attempted build of a GitHub Pages site, whether successful or not.

Triggered on push to a GitHub Pages enabled branch (`gh-pages` for project pages,`master` for user and organization pages).

Key | Type | Description

----|------|------------

`build` |`object` | The[page build](http://developer.github.com/v3/repos/pages/#list-pages-builds) itself.

`status` | Any time a Repository has a status update from the API

`deployment` | Any time a Repository has a new deployment created from the API.

`deployment_status` | Any time a deployment for the Repository has a status update from the API.

`page_build` | Any time a Pages site is built or results in a failed build.

`*` | Any time any event is triggered ([Wildcard Event](#wildcard-event)).

The payloads for all hooks mirror[the payloads for the Event