Skip to content

Commit 0d0eb83

Browse files
d-bytebaseclaude
andauthored
docs: update webhook supported events to match Activity.Type enum (#983)
Update webhook documentation to reflect current Activity.Type enum from project_service.proto. The supported events now include: - Issue created - Issue approval requested - Issue sent back - Pipeline failed - Pipeline completed This replaces the previous 9 events with the 5 events currently defined in the proto file. Co-authored-by: Claude Sonnet 4.5 <[email protected]>
1 parent 6f64ec4 commit 0d0eb83

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

docs/change-database/webhook.mdx

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,11 @@ User can configure project-level webhooks to let Bytebase post messages to the c
88

99
## Supported events
1010

11-
- `Issue creation` - Post message when issue belonging to the configured project has been created.
12-
- `Issue status change` - Post message when the status of the issue belonging to the configured project has been changed.
13-
- `Issue stage status change` - Post message when issue's enclosing stage status has been changed.
14-
- `Issue task status change` - Post message when issue's enclosing task status has been changed.
15-
- `Issue info change` - Post message when issue's basic info such as assignee, title, description has been changed.
16-
- `Issue comment creation` - Post message when new comment added to the issue.
17-
- `Issue approval needed` - Post message when issue needs approval.
18-
- `Issue approved` - Post message when issue has been approved.
19-
- `Issue rollout needed` - Post message when issue needs rollout.
11+
- `Issue created` - Post message when a new issue has been created.
12+
- `Issue approval requested` - Post message when an approval request has been made.
13+
- `Issue sent back` - Post message when an issue has been sent back by an approver.
14+
- `Pipeline failed` - Post message when a pipeline has failed.
15+
- `Pipeline completed` - Post message when a pipeline has completed successfully.
2016

2117
### Direct message
2218

@@ -31,9 +27,7 @@ The following events support sending direct messages/notifications to related us
3127
1. enabled the `Enable direct messages` option to enable this feature.
3228
1. configured the `IM` integration to send messages to related users.
3329

34-
- `Issue approval needed`
35-
- `Issue approved`
36-
- `Issue rollout needed`
30+
- `Issue approval requested`
3731

3832
## Supported webhook endpoints
3933

0 commit comments

Comments
 (0)