入职流程状态变更
待入职员工的入职流程流转时,例如调用流转入职任务接口会触发本事件。
Tip: 你需要在应用中配置事件订阅,这样才可以在事件触发时接收到事件数据。了解事件订阅可参见事件订阅概述。
事件
| 项目 | 值 |
|---|---|
| 事件类型 | corehr.pre_hire.onboarding_task_changed_v2 |
| 支持的应用类型 | custom,isv |
| 权限要求 订阅该事件所需的权限,开启其中任意一项权限即可订阅 | corehr:pre_hire: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 | \- | - |
└ tenant_id | string | 飞书人事租户ID |
└ pre_hire_id | string | 待入职ID |
└ onboarding_task_changes | onboarding_task_change\[\] | 入职任务状态变更 数据校验规则: - 长度范围: 0 ~ 1000 |
└ after_status | string | 变更后任务状态 可选值有: - uninitialized: 未初始化(内部状态无需关注) - not_started: 未开始 - in_progress: 进行中 - in_review: 审核中/审批中 - rejected: 已拒绝 - failed: 失败 - skipped: 自动跳过 - completed: 已完成 - terminated: 已终止 - initiating: 初始化中 - exception: 异常 - manual_skipped: 手动跳过 |
└ task_code | string | 任务标识码 如果是系统内置的任务,标识码与名称对应关系如下: 其中『创建账户SSO』为隐藏的任务节点,在『个人信息』前自动执行 |
└ onboarding_flow_change | onboarding_flow_change | 入职流程状态变更 - 当流程状态无变更,仅有任务状态变更时,此字段的会返回空 |
└ after_status | string | 入职流程状态变更 可选值有: - not_started: 未开始 - in_progress: 进行中 - completed: 已完成(所有任务节点均已完成) - withdrawn: 已撤销(撤销待入职) - others: 其他(异常情况) - expired: 已失效(回退至Offer沟通阶段) |
└ onboarding_flow_id | string | 待入职流程ID |
└ flow_info | onboarding_flow | 流程信息 |
└ id | string | 流程id |
└ name | i18n_v2 | 流程名称 |
└ zh_cn | string | zh-CN |
└ en_us | string | en-US |
事件体示例
json
{
"schema": "2.0",
"header": {
"event_id": "5e3702a84e847582be8db7fb73283c02",
"event_type": "corehr.pre_hire.onboarding_task_changed_v2",
"create_time": "1608725989000",
"token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
"app_id": "cli_9f5343c580712544",
"tenant_key": "2ca1d211f64f6438"
},
"event": {
"tenant_id": "6685321562717324807",
"pre_hire_id": "7225204420787144236",
"onboarding_task_changes": [
{
"after_status": "in_progress",
"task_code": "2"
}
],
"onboarding_flow_change": {
"after_status": "in_progress"
},
"onboarding_flow_id": "65c245b7859c6e77d2290e00",
"flow_info": {
"id": "628caefb0eb4ac9c806982ee",
"name": {
"zh_cn": "王冰",
"en_us": "Bob"
}
}
}
}事件订阅示例代码
订阅方式
长连接方式(推荐):无需发布到公网地址,在本地开发环境中即可接收事件回调,且无需处理加解密逻辑。 发送至开发者服务器:需要提供服务器公网地址。
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("", "").
OnP2PreHireOnboardingTaskChangedV2(func(ctx context.Context, event *larkcorehr.P2PreHireOnboardingTaskChangedV2) error {
fmt.Printf("[ OnP2PreHireOnboardingTaskChangedV2 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_pre_hire_onboarding_task_changed_v2(data: lark.corehr.v2.P2CorehrPreHireOnboardingTaskChangedV2) -> None:
print(f'[ do_p2_corehr_pre_hire_onboarding_task_changed_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_pre_hire_onboarding_task_changed_v2(do_p2_corehr_pre_hire_onboarding_task_changed_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.P2PreHireOnboardingTaskChangedV2;
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("", "")
.onP2PreHireOnboardingTaskChangedV2(new CorehrService.P2PreHireOnboardingTaskChangedV2Handler() {
@Override
public void handle(P2PreHireOnboardingTaskChangedV2 event) throws Exception {
System.out.printf("[ onP2PreHireOnboardingTaskChangedV2 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.pre_hire.onboarding_task_changed_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("", "").
OnP2PreHireOnboardingTaskChangedV2(func(ctx context.Context, event *larkcorehr.P2PreHireOnboardingTaskChangedV2) error {
fmt.Printf("[ OnP2PreHireOnboardingTaskChangedV2 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_pre_hire_onboarding_task_changed_v2(data: lark.corehr.v2.P2CorehrPreHireOnboardingTaskChangedV2) -> None:
print(f'[ do_p2_corehr_pre_hire_onboarding_task_changed_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_pre_hire_onboarding_task_changed_v2(do_p2_corehr_pre_hire_onboarding_task_changed_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.P2PreHireOnboardingTaskChangedV2;
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")
.onP2PreHireOnboardingTaskChangedV2(new CorehrService.P2PreHireOnboardingTaskChangedV2Handler() {
@Override
public void handle(P2PreHireOnboardingTaskChangedV2 event) throws Exception {
System.out.printf("[ onP2PreHireOnboardingTaskChangedV2 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.pre_hire.onboarding_task_changed_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);