Skip to content

Commit 13f148c

Browse files
committed
tweak the status event description
1 parent 4588a7e commit 13f148c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

content/v3/activity/events/types.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -270,18 +270,21 @@ release
270270

271271
## StatusEvent
272272

273-
Triggered when a new state is added to a ref.
273+
Triggered when the status of a Git commit changes.
274274

275275
Hook name: `status`
276276

277+
sha
278+
: **string** - The Commit SHA.
279+
277280
state
278281
: **string** - The new state. Can be `pending`, `success`, `failure`, or `error`.
279282

280283
description
281-
: **string** - The optional human-readable description added to the state.
284+
: **string** - The optional human-readable description added to the status.
282285

283286
target_url
284-
: **string** - The optional link added to the state.
287+
: **string** - The optional link added to the status.
285288

286289
## TeamAddEvent
287290

0 commit comments

Comments
 (0)