add page build event

benbalter · benbalter · commit 5bcb112f40b3 · 2014-03-12T11:06:11.000-07:00
diff --git a/content/changes/2014-03-12-page-build-event-for-webhooks.md b/content/changes/2014-03-12-page-build-event-for-webhooks.md
@@ -0,0 +1,14 @@
+---
+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
diff --git a/content/v3/activity/events/types.md b/content/v3/activity/events/types.md
@@ -405,3 +405,19 @@ event’s repository is the [repository](/v3/repos/) that was starred.
 Key | Type | Description
 ----|------|-------------
 `action`|`string` | The action that was performed. Currently, can only be `started`.
+
+## PageBuildEvent
+
+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).
+
+### Hook Name
+
+`page_build`
+
+### Payload
+
+Key | Type | Description
+----|------|------------
+`build` | `object` | The [page build](http://developer.github.com/v3/repos/pages/#list-pages-builds) itself.
diff --git a/content/webhooks/index.md b/content/webhooks/index.md
@@ -77,9 +77,9 @@ Name | Description
 `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)).
 
-
 ### Payloads
 
 The payloads for all hooks mirror [the payloads for the Event
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -45,6 +45,7 @@ module Helpers
         :izuzak       => 'ff743b4cba28cc47ad65cb90212c1e51',
         :spicycode    => '7ce90d712fab09421b7f2cf955b9a4c8',
         :dbussink     => 'b012094b37ab6946c44eaa41d7828478',
+        :benbalter    => '19d03ecc1ff5da1a5e63a3ddaa2d84c2',
       }
 
       DefaultTimeFormat = "%B %-d, %Y".freeze

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ module Helpers`
`45`	`45`	`:izuzak => 'ff743b4cba28cc47ad65cb90212c1e51',`
`46`	`46`	`:spicycode => '7ce90d712fab09421b7f2cf955b9a4c8',`
`47`	`47`	`:dbussink => 'b012094b37ab6946c44eaa41d7828478',`
	`48`	`+ :benbalter => '19d03ecc1ff5da1a5e63a3ddaa2d84c2',`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`DefaultTimeFormat = "%B %-d, %Y".freeze`