Skip to content

Commit 62d9ec7

Browse files
webhook direct msg (#490)
1 parent 07f0d57 commit 62d9ec7

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

content/docs/change-database/webhook.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ User can configure project-level webhooks to let Bytebase post messages to the c
1515
- `Issue info change` - Post message when issue's basic info such as assignee, title, description has been changed.
1616
- `Issue comment creation` - Post message when new comment added to the issue.
1717

18-
The following events support sending direct messages/notifications to related users, you must enable the `Enable direct messages` option to enable this feature.
18+
The following events support sending direct messages/notifications to related users, make sure you have:
19+
20+
1. enabled the `Enable direct messages` option to enable this feature.
21+
1. configured the `IM` integration to send messages to related users.
1922

2023
- `Issue approval needed` - Post message when issue needs approval.
2124
- `Issue approved` - Post message when issue has been approved.
@@ -111,6 +114,8 @@ Feishu (Lark) allows to specify a list of keywords in the [security setting](htt
111114
- `im:message:send_as_bot`
112115
1. Click **Create Version**.
113116
1. Configure [availability](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability).
117+
1. Go back to Bytebase and fill **App Id** and **App Secret** fields under **Integration > IM**.
118+
1. Go to **Integration > Webhooks** in a project, add a webhook, check all the events you want to send direct messages, and click **Create**.
114119

115120
### WeCom
116121

@@ -126,6 +131,8 @@ WeCom does not provide its own official guide. Please follow this similar [setup
126131
1. Configure **Allowed users**.
127132
1. Configure **Company's Trusted IP** to your Bytebase instance IP.
128133
1. Make sure the user's email in Bytebase is the same as the user's email (not External account) in WeCom.
134+
1. Go back to Bytebase and fill **Corp Id**, **Agent Id** and **Secret** fields under **Integration > IM**.
135+
1. Go to **Integration > Webhooks** in a project, add a webhook, check all the events you want to send direct messages, and click **Create**.
129136

130137
### Custom
131138

0 commit comments

Comments
 (0)