You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by zh...@apache.org on 2022/01/29 07:05:19 UTC
[dolphinscheduler-website] branch master updated: [plugin] Add WebexTeams alert plugin documentation (#662)
This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new 0686bdc [plugin] Add WebexTeams alert plugin documentation (#662)
0686bdc is described below
commit 0686bdc111de1145bfbf3473bf437880413a1b54
Author: wangyang <wa...@lqwang.net>
AuthorDate: Sat Jan 29 15:05:12 2022 +0800
[plugin] Add WebexTeams alert plugin documentation (#662)
---
.../user_doc/guide/alert/enterprise-webexteams.md | 24 ++++++++++++++++++++
.../user_doc/guide/alert/enterprise-webexteams.md | 25 +++++++++++++++++++++
img/alert/enterprise-webexteams-plugin.png | Bin 0 -> 259182 bytes
3 files changed, 49 insertions(+)
diff --git a/docs/en-us/dev/user_doc/guide/alert/enterprise-webexteams.md b/docs/en-us/dev/user_doc/guide/alert/enterprise-webexteams.md
new file mode 100644
index 0000000..8252fb7
--- /dev/null
+++ b/docs/en-us/dev/user_doc/guide/alert/enterprise-webexteams.md
@@ -0,0 +1,24 @@
+# WebexTeams
+
+If you need to use WebexTeams to alert, please create an alarm Instance in warning instance manage, and then choose the WebexTeams plugin. The configuration example of enterprise WebexTeams is as follows:
+
+
+
+
+parameter configuration
+
+* botAccessToken
+ > The robot's access token you were given
+* roomID
+ > The room ID of the message
+* toPersonId
+ > The person ID of the recipient when sending a private 1:1 message
+* toPersonEmail
+ > The email address of the recipient when sending a private 1:1 message
+* atSomeoneInRoom
+ > If the message destination is room, the user emails of the person being @, use ,(eng commas) to separate multiple emails
+* destination
+ > Provide only one message destination in the roomId, toPersonEmail, or toPersonId field
+
+[WebexTeams Application Bot Guide](https://developer.webex.com/docs/bots)
+[WebexTeams Message Guide](https://developer.webex.com/docs/api/v1/messages/create-a-message)
diff --git a/docs/zh-cn/dev/user_doc/guide/alert/enterprise-webexteams.md b/docs/zh-cn/dev/user_doc/guide/alert/enterprise-webexteams.md
new file mode 100644
index 0000000..4f82bcc
--- /dev/null
+++ b/docs/zh-cn/dev/user_doc/guide/alert/enterprise-webexteams.md
@@ -0,0 +1,25 @@
+# WebexTeams
+
+如果您需要使用到Webex Teams进行告警，请在告警实例管理里创建告警实例，选择 WebexTeams 插件。WebexTeams的配置样例如下:
+
+
+
+参数配置
+
+* botAccessToken
+ > 在创建机器人时，获得的访问令牌
+* roomID
+ > 接受消息的room ID(只支持一个ID)
+* toPersonId
+ > 接受消息的用户ID(只支持一个ID)
+* toPersonEmail
+ > 接受消息的用户邮箱(只支持一个邮箱)
+* atSomeoneInRoom
+ > 如果消息目的地为room，被@人的用户邮箱，多个邮箱用英文逗号分隔
+* destination
+ > 消息目的地，一条消息只支持一个目的地
+
+[WebexTeams申请机器人文档](https://developer.webex.com/docs/bots)
+[WebexTeamsMessage开发文档](https://developer.webex.com/docs/api/v1/messages/create-a-message)
+
+
diff --git a/img/alert/enterprise-webexteams-plugin.png b/img/alert/enterprise-webexteams-plugin.png
new file mode 100644
index 0000000..fff04ad
Binary files /dev/null and b/img/alert/enterprise-webexteams-plugin.png differ