1. Team Incoming Webhook 大綱
Intercoming Webhook 是 JANDI 中的一个功能,允许接收外部数据。但是,每位用户都必须经过以下流程,才能发送外部数据。
单独创建 Incoming Webhook,并将生成的 URL 发送给管理器。然后,管理器将 URL 与个人信息进行比对后,保存进行管理,若有任何人事异动如新人入职、离职或部门调动,管理者可以登录或删除 Incoming Webhook。
由上方范例可以看出,一旦创建 Incoming Webhook,对管理团队来说是很棘手的。所以为了解决这个问题,我们开发了 Team Incoming Webhook。
当管理员或所有者从 Team Incoming Webhook 发送个人识别( JANDI 注册电子邮箱) 至 Team Incoming Webhook 的 URL 串联时,可以启用个人信息传递。
这有助于 JANDI 用户能自由地外部链接服务器,通过个人信息功能依照工作条件发送至议题或私信的信息,都使 JANDI 的使用更加广泛。
2. Team Incoming Webhook Data Format
Team Incoming Webhook 是一个 RESTFul API,因此用户必须使用以下格式发送数据。
{ "email":"jandi@tosslab.com", "body":"[休假设定完成]", "connectColor":"#FAC11B", "connectInfo":[ { "title":"2017年 10月 24日 休假申请审核完成", "description":"2017.10.24 ~ 2017.10.26 年假申请", "imageUrl":"http://www.jandi.com/image.jpg" }, { "title":"2017年 10月 24日 休假申请审核完成", "description":"2017.10.24 ~ 2017.10.26 年假申请 " } ] }
<JSON Object Field>
Field | Data Type | Description |
String | 连接到 JANDI 的个人电子邮件地址 | |
body | String | 最上面的信息 |
connectColor | String | 信息底部的栏位颜色 |
connectInfo | Object [ ] | 文本中信息的排列 |
<connectInfo Object Field>
Field | Data Type | Description |
title | String | 信息底部文本气泡中的最上方讯息信息 |
description | String | 底部文本气泡中的中间信息 |
imageUrl | String | 信息底部文本气泡中显示的连结 URL |
3. Team Incoming Webhook Request
Webhook仅支援 HTTP POST Method
必须在请求中指定 Accept 和 Content-Type,如下所示。
Accept: application/vnd.tosslab.jandi-v2+json
Content-Type: application/json
另外请注意,如果存在2.Team Incoming Webhook Data格式之外的字段,则忽略或返回错误。
curl \-X POST \https://wh.jandi.com/connect-api/team-webhook/279/7dbe00d0784c8cf1758f04d824510703 \-H 'Accept:application/vnd.tosslab.jandi-v2+json' \-H 'Content-Type:application/json' \--data-binary '{ "email":"jandi@tosslab.com", "body":"[休假設定完成]", "connectColor":"#FAC11B", "connectInfo":[ { "title":"2017年 10月 24日 休假申請審核完成.", "description":"2017.10.24 ~ 2017.10.26 연차 신청", "imageUrl":"http://www.jandi.com/image.jpg" }, { "title":"2017年 10月 24日 休假申請審核完成", "description":"2017.10.24 ~ 2017.10.26 연차 신청 " } ] }'
Response 回应是
{ validEmails: [email1, email2, ...], // 發送Email地址 invalidEmails: [email1, email2, ...] // 發送Email地址}
99. Limit
- 60 requests / min
- 500 requests / 10 min
- 限制情况下的响应代码: 429
如果您想使用如上所述向您的个人“Chat JANDI”发送讯息的“Team Incoming Webhook”,则交互工作按照手册在内部完成。
请告诉我们的团队您希望将什么个人简介图片和名称应用于团队导入 Webhook。
Toss Lab 将发布 URL 申请所需的 Team ID 和 WebhookToken。
您可以将其输入为 https://wh.jandi.com/connect-api/team-webhook/{Team ID}/{Token}\。
您可以通过 support@tosslab.com 联系我们。
此功能仅适用于付费团队。