流程节点状态变更
流程中节点状态发生变化会触发该事件。配置的节点为节点定义(node_definition_id 是唯一标识)。在流程实例中,每个流程实例生成的节点实例会不同(此功能不受数据权限范围控制)。
Tip: 你需要在应用内配置事件订阅,并订阅该事件,这样才可以在事件触发时接收到事件数据。了解事件订阅可参见事件概述。
事件
| 项目 | 值 |
|---|---|
| 事件类型 | corehr.process.node.updated_v2 |
| 支持的应用类型 | custom,isv |
| 权限要求 订阅该事件所需的权限,开启其中任意一项权限即可订阅 | corehr:process: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 | \- | - |
└ flow_definition_id | string | 流程定义 id |
└ node_definition_id | string | 节点定义 id |
└ process_id | string | 流程运行实例 id,详细信息可通过获取单个流程详情获取 |
└ process_node_id | string | 节点运行实例 id |
└ node_type | int | 节点类型 可选值有: - 1: 审批节点 - 2: 抄送节点 - 5: 表单节点 - 6: 电子签 |
└ node_status | int | 节点状态 可选值有: - 1: 进行中 - 2: 已拒绝 - 3: 已通过 - 4: 已撤回 - 5: 已回退 - 6: 已跳过 - 7: 已干预 |
└ biz_type | string | 业务类型,详情请查看接入指南 数据校验规则: - 长度范围: 1 ~ 200 字符 |
事件体示例
json
{
"schema": "2.0",
"header": {
"event_id": "5e3702a84e847582be8db7fb73283c02",
"event_type": "corehr.process.node.updated_v2",
"create_time": "1608725989000",
"token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
"app_id": "cli_9f5343c580712544",
"tenant_key": "2ca1d211f64f6438"
},
"event": {
"flow_definition_id": "people_7182520625066475540_7222929439175839532",
"node_definition_id": "approval_7c7d9c4d25b",
"process_id": "7312658016791168538",
"process_node_id": "7311696871833994796",
"node_type": 1,
"node_status": 1,
"biz_type": "renewal_record"
}
}示例场景
一个流程需要依次经过「审批1」 -> 「审批2」这2个审批节点。
假设:
「审批1」的node_definition_id="approval_1"
「审批2」的node_definition_id="approval_2"
- 当流程发起后,并且「审批1」节点状态变成“进行中”,发送如下事件,其中"node_definition_id":"approval_1","node_status":1,表示「审批1」节点状态变为进行中
json
{"event":{"flow_definition_id":"people_7023711013443944467_7382148112896872236","node_definition_id":"approval_1","process_id":"7384728360900888108","process_node_id":"7384728405024982572","node_type":1,"node_status":1,"biz_type":"corehr_probation_default_flow"},"header":{"event_id":"e4b6da0748b238261c4eedb809666898","event_time":"1719391068392","tenant_id":"7024043141149753363"}}当审批人完成对「审批1」节点的审批,节点状态变成“已完成”,发送如下2个事件;
- "node_definition_id":"approval_1","node_status":3,表示「审批1」节点已完成
json
{"event":{"flow_definition_id":"people_7023711013443944467_7382148112896872236","node_definition_id":"approval_1","process_id":"7384728360900888108","process_node_id":"7384728405024982572","node_type":1,"node_status":3,"biz_type":"corehr_probation_default_flow"},"header":{"event_id":"c0ba07d36568182261cfb9dbab1260eb","event_time":"1719391089652","tenant_id":"7024043141149753363"}}- node_definition_id="approval_2",node_status=1的事件,表示「审批2」节点变为进行中
json
{"event":{"flow_definition_id":"people_7023711013443944467_7382148112896872236","node_definition_id":"approval_2","process_id":"7384728360900888108","process_node_id":"7384728494439155244","node_type":1,"node_status":1,"biz_type":"corehr_probation_default_flow"},"header":{"event_id":"f6206e0e152423585833295bc444fada","event_time":"1719391090119","tenant_id":"7024043141149753363"}}事件订阅示例代码
订阅方式
长连接方式(推荐):无需发布到公网地址,在本地开发环境中即可接收事件回调,且无需处理加解密逻辑。 发送至开发者服务器:需要提供服务器公网地址。
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("", "").
OnP2ProcessNodeUpdatedV2(func(ctx context.Context, event *larkcorehr.P2ProcessNodeUpdatedV2) error {
fmt.Printf("[ OnP2ProcessNodeUpdatedV2 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_process_node_updated_v2(data: lark.corehr.v2.P2CorehrProcessNodeUpdatedV2) -> None:
print(f'[ do_p2_corehr_process_node_updated_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_process_node_updated_v2(do_p2_corehr_process_node_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.P2ProcessNodeUpdatedV2;
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("", "")
.onP2ProcessNodeUpdatedV2(new CorehrService.P2ProcessNodeUpdatedV2Handler() {
@Override
public void handle(P2ProcessNodeUpdatedV2 event) throws Exception {
System.out.printf("[ onP2ProcessNodeUpdatedV2 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.process.node.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("", "").
OnP2ProcessNodeUpdatedV2(func(ctx context.Context, event *larkcorehr.P2ProcessNodeUpdatedV2) error {
fmt.Printf("[ OnP2ProcessNodeUpdatedV2 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_process_node_updated_v2(data: lark.corehr.v2.P2CorehrProcessNodeUpdatedV2) -> None:
print(f'[ do_p2_corehr_process_node_updated_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_corehr_process_node_updated_v2(do_p2_corehr_process_node_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.P2ProcessNodeUpdatedV2;
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")
.onP2ProcessNodeUpdatedV2(new CorehrService.P2ProcessNodeUpdatedV2Handler() {
@Override
public void handle(P2ProcessNodeUpdatedV2 event) throws Exception {
System.out.printf("[ onP2ProcessNodeUpdatedV2 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.process.node.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);