组织架构调整状态变更事件
- 当用户在『飞书人事-我的团队/人员管理-组织架构』,查看调整链接可以获取到 该用户发起的所有组织架构调整, 进入可找到审批流程。
- 当该审批单状态发生变更后, 用户会收到流程状态变更事件。
- 延迟说明:数据库主从延迟2s以内,即:用户接收到流程状态变更消息后2s内调用查询状态接口可能查不到变更信息。
前提条件
你需要在应用中配置事件订阅,这样才可以在事件触发时接收到事件数据。了解事件订阅可参见事件订阅概述。
事件
| 项目 | 值 |
|---|---|
| 事件类型 | corehr.approval_groups.updated_v2 |
| 支持的应用类型 | custom,isv |
| 权限要求 订阅该事件所需的权限,开启其中任意一项权限即可订阅 | corehr:approval_groups:read 获取组织架构调整流程信息 |
| 推送方式 | Webhook |
事件体
| 名称 | 类型 | 描述 |
|---|---|---|
schema | string | 事件模式 |
header | event_header | 事件头 |
└ event_id | string | 事件 ID |
└ event_type | string | 事件类型 |
└ create_time | string | 事件创建时间戳(单位:毫秒) |
└ token | string | 事件 Token |
└ app_id | string | 应用 ID |
└ tenant_key | string | 租户 Key |
event | \- | - |
└ approval_group_id | string | 组织架构调整审批组 ID |
└ process_id | string | 组织架构调整流程 ID, 用户通过『飞书人事-我的团队-组织架构』或『飞书 人事-人员管理-组织架构』 发起一个组织架构调整,并提交审批后,系统会根据管理员在审批流程中配置的规则,生成 一个或多个审批单据。 |
└ approval_group_status | int | 组织架构调整流程状态,枚举类型, 描述该审批单据的状态。 > Tip: 【不推荐使用,无法区分审批通过、执行失败和等待执行状态,推荐使用approval_group_status_v2】 可选值有: - 1: 审批中, 流程成功发起,并等待审批人审批。 可以通过『飞书人事-审批-我发起的』 / 『飞书人事-我的团队/人员管理-组织架构-调整记录』 找到审批单据。 - 2: 审批通过,该单据已通过审批, 调整记录等待写入。 一方面,组织架构调整支持拆单功能, 同一个调整可能发起多个审批, 当前审批单可能依赖其他审批通过才能写入。 - 3: 已完成,审批单中所有调整记录均写入完成。 ==该状态不代表调整的记录生效完成== 由于记录可能是未来生效, 因此记录的状态需通过 人员异动变更事件 、部门变更事件 和 岗位变更事件 获取。 - 人员异动变更事件:飞书人事-异动-事件 - 部门变更事件:飞书人事-组织管理-事件 - 岗位变更事件:【飞书人事-岗职务管理-岗位-事件】(岗位灰度内) - 4: 已拒绝,审批未通过。 - 5: 已撤销,用户主动撤销审批, 流程会进入已撤销状态。 |
└ topic | string | 调整主题, 用户在『飞书人事-我的团队/人员管理 -组织架构-发起调整』填写的调整变更主题 |
└ adjust_reason | string | 调整原因,用户在『飞书人事-我的团队/人员管理 -组织架构-发起调整』填写的调整变更详细原因, 便于审批人批阅。 |
└ effective_date | string | 生效日期 - 日期格式:YYYY-MM-DD - 最小值: 1900-01-01 - 最大值: 9999-12-31 |
└ created_by | string | 发起人,在『飞书人事-我的团队/人员管理 -组织架构-发起调整』填写的调整变更发起人。 |
└ draft_id | string | 组织架构调整 ID,用户在『飞书人事-我的团队/人员管理 -组织架构-发起调整』 时生成的唯一 ID。 |
└ draft_status | int | 整个组织架构调整状态,枚举类型,一个组织架构调整可能涉及多个审批流程。 该状态描述整个调整的审核状态 可选值有: - 1: 审批中,流程成功发起,并等待审批人审批。 可以通过『飞书人事-审批-我发起的』 / 『飞书人事-我的团队/人员管理-组织架构-调整记录』 找到审批单据。 - 2: 已完成, ==该状态不代表调整的记录生效完成== 由于记录可能是未来生效, 因此记录的状态需通过 人员异动变更事件 、部门变更事件 和 岗位变更事件 获取。 - 人员异动变更事件:飞书人事-异动-事件 - 部门变更事件: 飞书人事-组织管理-事件 - 岗位变更事件:【飞书人事-岗职务管理-岗位-事件】(岗位灰度内) - 3: 已撤销,用户主动撤销审批, 流程会进入已撤销状态。 |
└ approval_group_status_v2 | int | 组织架构调整流程状态,枚举类型,描述该审批单据的状态。 可选值有: - 1: 审批中,流程成功发起,并等待审批人审批。 可以通过『飞书人事-审批-我发起的』 / 『飞书人事-我的团队/人员管理-组织架构-调整记录』 找到审批单据。 - 2: 审批通过,该单据已通过审批,调整记录等待写入。 - 3: 已完成,审批单中所有调整记录均写入完成。 ==该状态不代表调整的记录生效完成== 由于记录可能是未来生效, 因此记录的状态需通过 人员异动变更事件 、部门变更事件 和 岗位变更事件 获取。 - 人员异动变更事件:飞书人事-异动-事件 - 部门变更事件: 飞书人事-组织管理-事件 - 岗位变更事件: 【飞书人事-岗职务管理-岗位-事件】(岗位灰度内) - 4: 已拒绝,审批未通过。 - 5: 已撤销,用户主动撤销审批,流程会进入已撤销状态。 - 6: 执行失败 或 等待执行。 - 该类型事件触发时机如下: - 商业化租户,未配置拆分审批流(整单): - 审批单中存在执行失败的调整项,此时审批单状态为【执行失败】,会触发该类型事件发送。 - 商业化租户,且配置拆分审批流(合单): - 审批单中存在执行失败的调整项,此时审批单状态为【执行失败】,会触发该类型事件发送。 - 审批单执行生效依赖另一个同时发起的还处于审批中状态审批单的执行结果,此时审批单状态为【等待执行】,会触发该类型事件发送。当被依赖审批单审批通过后,该审批单会根据执行结果再次发送【已完成】或【执行失败】事件。 - 字节租户: - 审批单中存在执行失败的调整项,此时审批单状态为【执行失败】,会触发该类型事件发送。 - 包含人员异动的审批单,审批通过时间早于审批单生效时间,此时审批单状态为【等待执行】,会触发该类型事件发送。到达审批单生效时间后,会根据执行结果再次发送【已完成】或【执行失败】事件。 - 用户收到该事件后,可通过以下接口查询审批单中包含调整记录的状态和变更详情: - 人员调整记录:批量查询人员调整内容 ==调整记录状态待支持== - 部门调整记录:批量查询部门调整内容 - 岗位调整记录:【飞书人事-组织架构调整-批量查询岗位调整内容】(岗位灰度内)==调整记录状态待支持== |
事件体示例
json
{
"schema": "2.0",
"header": {
"event_id": "5e3702a84e847582be8db7fb73283c02",
"event_type": "corehr.approval_groups.updated_v2",
"create_time": "1608725989000",
"token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
"app_id": "cli_9f5343c580712544",
"tenant_key": "2ca1d211f64f6438"
},
"event": {
"approval_group_id": "6991776076699549697",
"process_id": "6991776076699549697",
"approval_group_status": 1,
"topic": "测试组织架构调整",
"adjust_reason": "测试",
"effective_date": "2022-03-01",
"created_by": "6974641477444060708",
"draft_id": "6991776076699549697",
"draft_status": 1,
"approval_group_status_v2": 1
}
}事件订阅示例代码
订阅方式
长连接方式(推荐):无需发布到公网地址,在本地开发环境中即可接收事件回调,且无需处理加解密逻辑。 发送至开发者服务器:需要提供服务器公网地址。
package main
import (
"context"
"fmt"
larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
"github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
"github.com/larksuite/oapi-sdk-go/v3/service/corehr/v2"
larkws "github.com/larksuite/oapi-sdk-go/v3/ws"
)
// SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/preparations
func main() {
// 注册事件 Register event
eventHandler := dispatcher.NewEventDispatcher("", "").
OnP2ApprovalGroupsUpdatedV2(func(ctx context.Context, event *larkcorehr.P2ApprovalGroupsUpdatedV2) error {
fmt.Printf("[ OnP2ApprovalGroupsUpdatedV2 access ], data: %s\n", larkcore.Prettify(event))
return nil
})
// 构建 client Build client
cli := larkws.NewClient("YOUR_APP_ID", "YOUR_APP_SECRET",
larkws.WithEventHandler(eventHandler),
larkws.WithLogLevel(larkcore.LogLevelDebug),
)
// 建立长连接 Establish persistent connection
err := cli.Start(context.Background())
if err != nil {
panic(err)
}
}# SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/python--sdk/preparations-before-development
import lark_oapi as lark
def do_p2_corehr_approval_groups_updated_v2(data: lark.corehr.v2.P2CorehrApprovalGroupsUpdatedV2) -> None:
print(f'[ do_p2_corehr_approval_groups_updated_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_approval_groups_updated_v2(do_p2_corehr_approval_groups_updated_v2) \
.build()
def main():
# 构建 client Build client
cli = lark.ws.Client("APP_ID", "APP_SECRET",
event_handler=event_handler, log_level=lark.LogLevel.DEBUG)
# 建立长连接 Establish persistent connection
cli.start()
if __name__ == "__main__":
main()package com.example.sample;
import com.lark.oapi.core.utils.Jsons;
import com.lark.oapi.service.corehr.CorehrService;
import com.lark.oapi.service.corehr.v2.model.P2ApprovalGroupsUpdatedV2;
import com.lark.oapi.event.EventDispatcher;
import com.lark.oapi.ws.Client;
// SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/java-sdk-guide/preparations
public class Sample {
// 注册事件 Register event
private static final EventDispatcher EVENT_HANDLER = EventDispatcher.newBuilder("", "")
.onP2ApprovalGroupsUpdatedV2(new CorehrService.P2ApprovalGroupsUpdatedV2Handler() {
@Override
public void handle(P2ApprovalGroupsUpdatedV2 event) throws Exception {
System.out.printf("[ onP2ApprovalGroupsUpdatedV2 access ], data: %s\n", Jsons.DEFAULT.toJson(event.getEvent()));
}
})
.build();
public static void main(String[] args) {
// 构建 client Build client
Client client = new Client.Builder("APP_ID", "APP_SECRET")
.eventHandler(EVENT_HANDLER)
.build();
// 建立长连接 Establish persistent connection
client.start();
}
}// SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/nodejs-sdk/preparation-before-development
import * as Lark from '@larksuiteoapi/node-sdk';
const baseConfig = {
appId: 'APP_ID',
appSecret: 'APP_SECRET'
}
// 构建 client Build client
const wsClient = new Lark.WSClient(baseConfig);
// 建立长连接 Establish persistent connection
wsClient.start({
// 注册事件 Register event
eventDispatcher: new Lark.EventDispatcher({}).register({
'corehr.approval_groups.updated_v2': async (data) => {
console.log(data);
}
})
});package main
import (
"context"
"fmt"
"net/http"
larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
"github.com/larksuite/oapi-sdk-go/v3/core/httpserverext"
larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
"github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
"github.com/larksuite/oapi-sdk-go/v3/service/corehr/v2"
)
// SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/preparations
func main() {
// 注册事件 Register event
eventHandler := dispatcher.NewEventDispatcher("", "").
OnP2ApprovalGroupsUpdatedV2(func(ctx context.Context, event *larkcorehr.P2ApprovalGroupsUpdatedV2) error {
fmt.Printf("[ OnP2ApprovalGroupsUpdatedV2 access ], data: %s\n", larkcore.Prettify(event))
return nil
})
// 创建路由处理器 Create route handler
http.HandleFunc("/webhook/event", httpserverext.NewEventHandlerFunc(handler, larkevent.WithLogLevel(larkcore.LogLevelDebug)))
err := http.ListenAndServe(":7777", nil)
if err != nil {
panic(err)
}
}# SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/python--sdk/preparations-before-development
from flask import Flask
from lark_oapi.adapter.flask import *
import lark_oapi as lark
app = Flask(__name__)
def do_p2_corehr_approval_groups_updated_v2(data: lark.corehr.v2.P2CorehrApprovalGroupsUpdatedV2) -> None:
print(f'[ do_p2_corehr_approval_groups_updated_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_approval_groups_updated_v2(do_p2_corehr_approval_groups_updated_v2) \
.build()
# 创建路由处理器 Create route handler
@app.route("/webhook/event", methods=["POST"])
def event():
resp = event_handler.do(parse_req())
return parse_resp(resp)
if __name__ == "__main__":
app.run(port=7777)package com.lark.oapi.sample.event;
import com.lark.oapi.core.utils.Jsons;
import com.lark.oapi.service.corehr.CorehrService;
import com.lark.oapi.service.corehr.v2.model.P2ApprovalGroupsUpdatedV2;
import com.lark.oapi.sdk.servlet.ext.ServletAdapter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
// SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/java-sdk-guide/preparations
@RestController
public class EventController {
// 注册事件 Register event
private static final EventDispatcher EVENT_HANDLER = EventDispatcher.newBuilder("verificationToken", "encryptKey")
.onP2ApprovalGroupsUpdatedV2(new CorehrService.P2ApprovalGroupsUpdatedV2Handler() {
@Override
public void handle(P2ApprovalGroupsUpdatedV2 event) throws Exception {
System.out.printf("[ onP2ApprovalGroupsUpdatedV2 access ], data: %s\n", Jsons.DEFAULT.toJson(event.getEvent()));
}
})
.build();
// 注入 ServletAdapter 实例 Inject ServletAdapter instance
@Autowired
private ServletAdapter servletAdapter;
// 创建路由处理器 Create route handler
@RequestMapping("/webhook/event")
public void event(HttpServletRequest request, HttpServletResponse response)
throws Throwable {
// 回调扩展包提供的事件回调处理器 Callback handler provided by the extension package
servletAdapter.handleEvent(request, response, EVENT_DISPATCHER);
}
}// SDK 使用说明 SDK user guide:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/nodejs-sdk/preparation-before-development
import http from 'http';
import * as lark from '@larksuiteoapi/node-sdk';
// 注册事件 Register event
const eventDispatcher = new lark.EventDispatcher({
encryptKey: '',
verificationToken: '',
}).register({
'corehr.approval_groups.updated_v2': async (data) => {
console.log(data);
return 'success';
},
});
const server = http.createServer();
// 创建路由处理器 Create route handler
server.on('request', lark.adaptDefault('/webhook/event', eventDispatcher));
server.listen(3000);