人员信息变更
人员领域事件变更,通过业务界面、开放平台接口对个人信息、工作信息(雇佣信息)、任职信息、兼职信息等进行操作时会触发相应事件
Warning: - 【批量查询员工信息】、【搜索员工信息】 等数据查询存在一定延迟,不建议收到事件后立即查询以上接口。请在收到事件后,延迟 5~10 秒后查询。
- 兼职(event_type=4)的事件会延迟 10 秒发送。
- 当前事件是基于对象纬度触发,单次操作可能会产生多个事件,如入职、异动等 bpm 表单场景。
Tip: - 该事件触发场景:
- 人事系统:添加人员、修改任职信息、修改雇佣信息、修改个人信息、修改兼职信息、发起异动、导入编辑等业务操作
- 开放平台:调用创建、更新个人信息、雇佣信息、任职信息,发起异动、添加人员等接口时
- 计算字段的变更不会触发该事件
- 事件在重试、补偿等情况下可能会重复发送,订阅者请注意自行实现幂等逻辑
事件
| 项目 | 值 |
|---|---|
| 事件类型 | corehr.employee.domain_event_v2 |
| 支持的应用类型 | custom |
| 权限要求 订阅该事件所需的权限,开启其中任意一项权限即可订阅 | corehr:employee.event: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 | \- | - |
└ event_type | int | 事件类型 可选值有: - 1: 员工入职 - 2: 更新人员信息 - 4: 员工兼职变动 - 5: 员工主任职变动 - 7: 员工离职 - 8: 自定义组织记录变动 |
└ sub_event_type | int | 子事件类型 可选值有: - 1001: 新入职 - 2001: 更新人员信息 - 4001: 创建兼职 - 4002: 编缉兼职(更新兼职的任一字段就会触发该事件,包括更新【结束日期】) - 4003: 撤销兼职(弃用) - 4004: 结束兼职(目前含义为数据变更,即首次设置【结束日期】时会触发) - 4005: 删除兼职 - 5001: 添加异动 - 5002: 编辑异动信息 - 5003: 撤销异动 - 7001: 离职通过 - 7002: 撤销离职 - 8001: 新增第一条记录 - 8002: 新增第一条之后的自定义组织记录 - 8003: 编辑自定义组织记录 |
└ operator_user_id | string | 操作用户 ID |
└ opt_scene | string | 业务场景 - 标识触发此事件操作场景:系统页面操作、开发平台接口操作等 |
└ opt_desc | string | 操作描述 |
└ opt_time | string | 操作时间戳,单位:秒 |
└ opt_id | string | 操作 ID |
└ employment_id | string | 被操作人的雇佣 ID |
└ data | employee_domain_event_data\[\] | 变更数据 数据校验规则: - 长度范围: 0 ~ 1000 |
└ id | string | 变更实体的 ID - 雇佣ID,个人信息ID - 特殊: - 任职记录版本ID:请使用批量查询员工任职获取任职记录,对照 version_id 字段查找对象 |
└ entity | string | 变更实体标识,如: - job_data: 任职信息 - person:个人信息 - employment:雇佣信息 - email: 邮箱 - person_name:姓名 |
└ agg_entity | string | 聚合实体标识,如: - job_data: 任职信息 - person:个人信息 - employment:雇佣信息 |
└ agg_entity_id | string | 聚合实体 ID,父对象 ID,如: - person:个人信息 ID - employment:雇佣 ID |
└ opt_type | int | 操作类型 可选值有: - 1: 新增 - 2: 修改 - 3: 删除 |
└ fields | string\[\] | 字段标识,ApiName 数据校验规则: - 长度范围: 0 ~ 1000 |
事件体示例
json
{
"schema": "2.0",
"header": {
"event_id": "5e3702a84e847582be8db7fb73283c02",
"event_type": "corehr.employee.domain_event_v2",
"create_time": "1608725989000",
"token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
"app_id": "cli_9f5343c580712544",
"tenant_key": "2ca1d211f64f6438"
},
"event": {
"event_type": 1,
"sub_event_type": 1001,
"operator_user_id": "7216228370772919852",
"opt_scene": "OpenAPIAddEmployee",
"opt_desc": "开放平台创建任职记录V1接口入职员工",
"opt_time": "1697701824",
"opt_id": "7291571779879978540",
"employment_id": "7324965529786844716",
"data": [
{
"id": "7291573441955235372",
"entity": "email",
"agg_entity": "person",
"agg_entity_id": "7291273149417948716",
"opt_type": 1,
"fields": [
"fields apiname"
]
}
]
}
}事件订阅示例代码
订阅方式
长连接方式(推荐):无需发布到公网地址,在本地开发环境中即可接收事件回调,且无需处理加解密逻辑。 发送至开发者服务器:需要提供服务器公网地址。
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("", "").
OnP2EmployeeDomainEventV2(func(ctx context.Context, event *larkcorehr.P2EmployeeDomainEventV2) error {
fmt.Printf("[ OnP2EmployeeDomainEventV2 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_employee_domain_event_v2(data: lark.corehr.v2.P2CorehrEmployeeDomainEventV2) -> None:
print(f'[ do_p2_corehr_employee_domain_event_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_employee_domain_event_v2(do_p2_corehr_employee_domain_event_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.P2EmployeeDomainEventV2;
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("", "")
.onP2EmployeeDomainEventV2(new CorehrService.P2EmployeeDomainEventV2Handler() {
@Override
public void handle(P2EmployeeDomainEventV2 event) throws Exception {
System.out.printf("[ onP2EmployeeDomainEventV2 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.employee.domain_event_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("", "").
OnP2EmployeeDomainEventV2(func(ctx context.Context, event *larkcorehr.P2EmployeeDomainEventV2) error {
fmt.Printf("[ OnP2EmployeeDomainEventV2 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_employee_domain_event_v2(data: lark.corehr.v2.P2CorehrEmployeeDomainEventV2) -> None:
print(f'[ do_p2_corehr_employee_domain_event_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_employee_domain_event_v2(do_p2_corehr_employee_domain_event_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.P2EmployeeDomainEventV2;
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")
.onP2EmployeeDomainEventV2(new CorehrService.P2EmployeeDomainEventV2Handler() {
@Override
public void handle(P2EmployeeDomainEventV2 event) throws Exception {
System.out.printf("[ onP2EmployeeDomainEventV2 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.employee.domain_event_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);