Merge pull request #75 from github/deployment-events

izuzak · izuzak · commit cc36004de1ae · 2014-01-13T04:01:42.000-08:00
Add information on deployment events
diff --git a/content/v3/activity/events/types.md b/content/v3/activity/events/types.md
@@ -65,6 +65,43 @@ Key | Type | Description
 `ref_type`|`string` | The object that was deleted. Can be "branch" or "tag".
 `ref`|`string` | The full git ref.
 
+## DeploymentEvent
+
+Represents a [deployment](/v3/repos/deployments/#list-deployments).
+
+### Hook name
+
+`deployment`
+
+### Payload
+
+Key | Type | Description
+----|------|-------------
+`sha`        |`string` | The commit SHA for which this deployment was created.
+`name`       |`string` | Name of repository for this deployment, formatted as `:owner/:repo`.
+`payload`    |`string` | The optional extra information for this deployment.
+`description`|`string` | The optional human-readable description added to the deployment.
+
+
+## DeploymentStatusEvent
+
+Represents a [deployment status](/v3/repos/deployments/#list-deployment-statuses).
+
+### Hook name
+
+`deployment_status`
+
+### Payload
+
+Key | Type | Description
+----|------|-------------
+`sha`        |`string` | The commit SHA for the associated deployment.
+`name`       |`string` | Name of repository for the associated deployment, formatted as `:owner/:repo`.
+`state`      |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`.
+`payload`    |`string` | The optional extra information for the associated deployment.
+`target_url` |`string` | The optional link added to the status.
+`description`|`string` | The optional human-readable description added to the status.
+
 
 ## DownloadEvent
 
diff --git a/content/v3/repos/hooks.md b/content/v3/repos/hooks.md
@@ -72,6 +72,9 @@ Name | Description
 `public` | Any time a Repository changes from private to public.
 `team_add` | Any time a team is added or modified on a Repository.
 `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.
+
 
 ### Payloads
 
