Teambition API
Webhook
Teambition API
快速开始
开发企业内部应用
开发应用商店应用
应用商店应用发布指南
应用开发流程
创建应用
应用凭证和基本信息
邀请开发人员
测试应用
发布应用
查看操作日志
开发应用
安全域名
应用入口配置
应用权限
组件
开发指南
调用频率限制
Postman 模版请求 API 使用说明
授权凭证
应用免登
API
身份验证(免登)
请求身份验证
获取登录用户身份
获取登录用户信息
用户
查询 IDMap
批量查询用户应用可见性
企业
获取企业信息
根据自定义字段分类统计自定义字段数
搜索企业任务类型
通讯录
成员
获取企业的管理员(含拥有者)
获取企业拥有者
获取企业成员列表
添加企业成员
更新企业成员
启用企业成员账号
停用企业成员账号
删除企业成员
获取企业成员数量
批量获取企业成员
搜索企业成员
部门
获取企业部门列表
获取部门成员列表
获取用户加入的企业部门列表
任务
更新自由任务标题
创建自由任务
查询自由任务详情
更新自由任务截止时间
更新自由任务执行者
更新自由任务参与者
更新自由任务完成态
更新自由任务备注
获取任务关联信息
创建任务关联
删除任务关联
更新自由任务优先级
查询项目任务
归档任务(移入回收站)
评论任务
更新任务标题
复制任务(仅支持工作流项目)
创建任务
根据字段InstanceId更新任务自定义字段值(弃用)
更新任务自定义字段值
删除任务
更新任务截止时间
更新任务执行者
更新任务参与者
移动任务(仅支持工作流项目)
更新任务备注
工时
工时应用相关接口的准备工作检查清单
获取单个实际工时详情
获取单个计划工时详情
获取单个任务的实际工时列表
获取单个任务的计划工时列表
获取单个任务的实际工时总和
获取单个任务的计划工时总和
获取一定时间内订阅的指定用户的实际工时聚合数
获取一定时间内订阅的指定用户的计划工时聚合数
项目
创建项目
更新项目
删除项目
查询项目详情
添加项目成员
获取项目成员
删除项目成员
检查用户是否为项目的成员
更新项目成员的角色
项目分组
角色
名额
群聊
统计
历史版本(不推荐)
任务
创建任务
更新任务
查询任务
删除任务
TQL查询任务
创建任务列表
查询任务列表
删除任务列表
创建任务分组
更新任务分组
查询任务分组
删除任务分组
查询任务类型
获取任务类型
判断任务类型是否存在
查询工作流信息
查询任务依赖关系
查询任务关联关系
删除任务关联
创建任务关联关系
查询用户信息
查询用户设置
使用邮箱获取用户 ID
获取三方账号的信息
批量查询用户信息
更新 IDMap
模型说明
迭代
获取迭代信息
创建迭代
更新迭代
删除迭代
获取迭代列表
日程
创建日程
更新日程
查询日程
移除日程
文件
获取文件夹信息
获取文件信息
标签
查询标签
TQL查询语音
TQL介绍
企业(丢弃)
添加企业成员
获取企业成员列表
获取企业成员数量
获取企业的管理员(含拥有者)
获取企业拥有者
删除企业成员
搜索企业成员
批量获取企业成员
启用企业成员账号
停用企业成员账号
获取企业部门列表
获取企业部门成员列表
获取用户加入的企业部门列表
评论
创建任务评论
Webhook
企业自建应用 Webhook 信息推送的建立
Webhook请求合法性验证
企业
更新企业
企业改名
删除企业
转交拥有者
添加企业成员
更新企业成员
移除企业成员
激活企业成员
停用企业成员
部门
创建部门
更新部 门
移动部门
删除部门
添加部门成员
删除部门成员
项目
创建项目
删除项目
自定义字段更新
任务
创建任务
更新任务
删除任务
日程
创建日程
更新日程
删除日程
参与人更新
自定义字段更新
日程提醒
关联
创建关联
删除关联
评论
触发评论
文件
文件创建
文件删除
文件移动
文件改名
参与人更新
应用
企业安装应用
企业卸载应用
企业开启应用
企业禁用应用
项目开启应用
项目关闭应用
创建应用可见范围
移除应用可见范围
规范与指导
设计规范
图标规范
宣传图规范
Webhook
企业自建应用 Webhook 信息推送的建立
功能介绍
#
企业自建应用的开发者可以给应用添加 Webhook 推送的能力。可以让安装了本应用的企业,全企业范围内特定类别(如任务、项目等)的
所有对象
变动信息向配置的地址推送。可以创建用于监听、同步和诊断的日志流。
*注意:当前的实现中,企业安装应用后,内容推送会被全企业范围内的变动触发,即,假设建立了任务相关的推送,企业内的所有任务变动都会形成推送,请注意在消费端过滤。我们有计划在将来支持逐资源、细分场景建立 Webhook 订阅的的模式。
建立推送
#
如何让自己的应用可以发起此类 Webhook 推送:
首先,搭建 好接收方的配置,获得接收地址,和对应的解析能力, 本例中假设是这个地址:
https://www.consumer.com/helloworld
然后,前往开放平台,开发者后台对应应用的 Webhook 界面, 添加接收地址,比如
https://www.consumer.com/helloworld
最后,前往开发者后台对应应用的应用权限界面,给这个应用添加相关资源的权限,比如希望收到任务创建通知的,就是添加任务权限。
在发布后,
新安装此应用的企业,如果有被授权类别的对象发生了变动,就形成消息推送给开头定义的地址。
已安装此应用的企业,需要主动安装最新版本才会按照最新的推送范围进行推送。
具体推送事件的范围和 payload 的格式说明请参考开放平台相关文档 Webhook 目录下的的介绍。
高级功能
#
Base64加密
#
如果你处理报文的系统会涉及大量用户输入,需要对注入攻击等情形进行保护,可以选择对报文体开启 Base64加密
开启后,
需要重新发布应用
,后续报文消息header 会有Content-Transfer-Encoding : "base64" ,Body 部分则会被 Base64 加密,在接收端解密即可
重启中断推送
#
如果因为某些原因推送中断了,通常因为下游接收端长期无响应,开发者可以排查完错误后,自助重启推送。
从点击重启到推送实际恢复会有一定的延迟,请等待最多 30分钟后验证。
【Teambition】API开发者 微信交流群
用微信扫右侧二维码,加入【Teambition】API开发者 交流群,互助沟通
扫码加入交流群
修改于
2022-02-28 07:58:36
上一页
创建任务评论
下一页
Webhook请求合法性验证