Webhook

User can configure project-level webhooks to let Bytebase post messages to the configured webhook endpoint upon various events.

Supported events#

• Issue creation - Post message when issue belonging to the configured project has been created.
• Issue status change - Post message when the status of the issue belonging to the configured project has been changed.
• Issue stage status change - Post message when issue's enclosing stage status has been changed.
• Issue task status change - Post message when issue's enclosing task status has been changed.
• Issue info change - Post message when issue's basic info such as assignee, title, description has been changed.
• Issue comment creation - Post message when new comment added to the issue.

The following events support sending direct messages/notifications to related users, make sure you have:

1. enabled the Enable direct messages option to enable this feature.
2. configured the IM integration to send messages to related users.

• Issue approval needed - Post message when issue needs approval.
• Issue approved - Post message when issue has been approved.
• Issue rollout needed - Post message when issue needs rollout.

Supported webhook endpoints#

Slack#

Official guide

Configure sending direct messages to related users#

1. Go to https://api.slack.com/apps.

2. Click Create New App.

3. Choose From an app manifest.

4. Pick your workspace to develop the app and click Next.

5. Replace the existing JSON with this manifest content and click Next.

   {
     "display_information": {
         "name": "Bytebase Bot"
     },
     "features": {
         "bot_user": {
             "display_name": "Bytebase Bot",
             "always_online": false
         }
     },
     "oauth_config": {
         "scopes": {
             "bot": [
                 "users:read",
                 "users:read.email",
                 "channels:manage",
                 "groups:write",
                 "im:write",
                 "chat:write",
                 "mpim:write"
             ]
         }
     },
     "settings": {
         "org_deploy_enabled": false,
         "socket_mode_enabled": false,
         "token_rotation_enabled": false
     }
   }

6. Click Create.

7. Click Install to Workspace and click Allow.

8. Go to Features > OAuth & Permissions and copy the Bot User OAuth Token.

9. Go back to Bytebase and paste the Bot User OAuth Token to the Token field under Integration > IM.

10. Go to Integration > Webhooks in a project, add a webhook, check all the events you want to send direct messages, and click Create.

Discord#

Official guide

Microsoft Teams#

Official guide

DingTalk#

Official guide

Configure sending direct messages to related users#

1. Go to https://open-dev.dingtalk.com/.
2. Select Application Development, click Create Application.
3. Select Credentials and Basic Information on the left sidebar. Obtain the Client ID and Client Secret.
4. Select Permission Management, grant the following permissions:
   • qyapi_get_member_by_mobile
   • qyapi_robot_sendmsg
5. Select Add Application Capability, add the Robot capability. Configure the robot, and for Message receiving mode select Stream mode. In "Robot Configuration", click Copy RobotCode to obtain the Robot Code. Publish the robot.
6. Select Version Management and Release. Click Create New Version. Fill in the relevant information, then Save and Directly Publish.
7. Go back to Bytebase and fill Client ID, Client Secret and Robot Code fields under Integration > IM.
8. Go to Integration > Webhooks in a project, add a webhook, check all the events you want to send direct messages, and click Create.

DingTalk allows to specify a list of keywords in the security setting to protect webhook endpoint. You can add "Bytebase" to that keyword list.

Feishu (Lark)#

Official guide

Feishu (Lark) allows to specify a list of keywords in the security setting to protect webhook endpoint. You can add "Bytebase" to that keyword list.

Configure sending direct notifications to related users#

1. Go to https://open.feishu.cn/app.
2. Click Create Custom App, fill the form and click Create.
3. Click Add Features on the left sidebar, add the Bot feature.
4. Click Permisions & Scopes on the left sidebar, find and add the following permissions:
   • contact:user.id:readonly
   • im:message:send_as_bot
5. Click Create Version.
6. Configure availability.
7. Go back to Bytebase and fill App Id and App Secret fields under Integration > IM.
8. Go to Integration > Webhooks in a project, add a webhook, check all the events you want to send direct messages, and click Create.

WeCom#

WeCom does not provide its own official guide. Please follow this similar setup from Tencent Cloud instead.

Configure sending direct messages to related users#

1. Go to https://work.weixin.qq.com/wework_admin/frame#apps.
2. Click the tab My Company, and then you can find Company ID in the Company Information.
3. Click the tab App Management, and choose Create an app under Self-built.
4. Open the app,
   1. Find AgentId and Secret.
   2. Configure Allowed users.
   3. Configure Company's Trusted IP to your Bytebase instance IP.
5. Make sure the user's email in Bytebase is the same as the user's email (not External account) in WeCom.
6. Go back to Bytebase and fill Corp Id, Agent Id and Secret fields under Integration > IM.
7. Go to Integration > Webhooks in a project, add a webhook, check all the events you want to send direct messages, and click Create.