Skip to content

Commit c6b92e2

Browse files
committed
Merge pull request github#772 from github/update-1431700604
2 parents 289ef76 + 13a8d3f commit c6b92e2

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

content/v3/activity/events/types.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@ Events of this type are not visible in timelines, they are only used to trigger
8787

8888
Key | Type | Description
8989
----|------|-------------
90-
`sha` |`string` | The commit SHA for which this deployment was created.
91-
`name` |`string` | Name of repository for this deployment, formatted as `:owner/:repo`.
92-
`payload` |`string` | The optional extra information for this deployment.
93-
`environment`|`string` | The optional environment to deploy to. Default: `"production"`
94-
`description`|`string` | The optional human-readable description added to the deployment.
95-
90+
`deployment` |`object` | The [deployment](/v3/repos/deployments/#list-deployments).
91+
`deployment`[`"sha"`] |`string` | The commit SHA for which this deployment was created.
92+
`deployment`[`"payload"`] |`string` | The optional extra information for this deployment.
93+
`deployment`[`"environment"`] |`string` | The optional environment to deploy to. Default: `"production"`
94+
`deployment`[`"description"`] |`string` | The optional human-readable description added to the deployment.
95+
`repository` |`object` | The [repository](/v3/repos/) for this deployment.
9696

9797
<%= webhook_payload "deployment" %>
9898

@@ -110,10 +110,12 @@ Events of this type are not visible in timelines, they are only used to trigger
110110

111111
Key | Type | Description
112112
----|------|-------------
113-
`state` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`.
114-
`target_url` |`string` | The optional link added to the status.
115-
`deployment` |`object` | The deployment that this status is associated with.
116-
`description`|`string` | The optional human-readable description added to the status.
113+
`deployment_status` |`object` | The [deployment status](/v3/repos/deployments/#list-deployment-statuses).
114+
`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`.
115+
`deployment_status["target_url"]` |`string` | The optional link added to the status.
116+
`deployment_status["description"]`|`string` | The optional human-readable description added to the status.
117+
`deployment` |`object` | The [deployment](/v3/repos/deployments/#list-deployments) that this status is associated with.
118+
`repository` |`object` | The [repository](/v3/repos/) for this deployment.
117119

118120
<%= webhook_payload "deployment_status" %>
119121

0 commit comments

Comments
 (0)