# 工作流事件

通过订阅下述工作流的变化事件，在发生这些事件变更时开放平台将会通知给对应开发者

注意事项:

  • 需要先在平台开通工作流变更事件的权限
  • 在[事件订阅][事件列表]内配置所需的工作流事件
  • 等待系统创建的审批流程通过后自动生效

# 事件集合

# 任务创建

当任务被创建时推送

基本
事件类型 workflow.message.task.create
支持的应用类型 自建应用
权限要求 [工作流]-[获取工作流事件变更]
字段权限要求 无
推送方式 webhook

# 事件体

名称 类型 描述
header event_header 事件头
 ∟ event_id string 事件 ID
 ∟ event_type string 事件类型 workflow.message.task.create
 ∟ create_time string 事件创建时间戳（单位：毫秒）
 ∟ token string 事件 Token
 ∟ app_id string 应用 ID
 ∟ tenant_key string 租户 Key
event - -
 ∟operator object 创建人
 ∟ ∟union_id object 用户的 union id
 ∟ ∟user_id object 用户的 user_id 字段权限要求：获取用户ID
 ∟ ∟open_id object 用户的 open id
 ∟message object 事件中包含的消息内容
 ∟ ∟workflow_id string 工作流id
 ∟ ∟workflow_group_id string 工作流分组id
 ∟ ∟task_id string 任务id

# 事件体示例

{
  "header": {
    //示例值
    "event_id": "bbcce6e9-2ba4-4031-9b3c-8e610f3e0b73",
    "event_type": "workflow.subscribe",
    "create_time": "1662444442165",
    "token": "qwerasdfzxcv",
    "app_id": "bli_xxxxxxxxxxxxxxxxx",
    "tenant_key": "xxxxxxxxxxxxxxxxxxxx"
  },
  "event": {
    "operator": {
      //示例值
      "union_id": "on_123456789012345678901234567890",
      "user_id": "00000000",
      "open_id": "ou_123456789012345678901234567890",
      "staff_no": "00000000",
      "tenant_key": "qwerasdfzxcv"
    },
    "message": {
      //示例值
      "workflow_id": "qwerasdfzxcv",
      "workflow_group_id": "qwerasdfzxcv",
      "task_id": "qwerasdfzxcv"
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# 任务删除

当任务被删除时推送

基本
事件类型 workflow.message.task.delete
支持的应用类型 自建应用
权限要求 [工作流]-[获取工作流事件变更]
字段权限要求 无
推送方式 webhook

# 事件体

名称 类型 描述
header event_header 事件头
 ∟ event_id string 事件 ID
 ∟ event_type string 事件类型 workflow.message.task.delete
 ∟ create_time string 事件创建时间戳（单位：毫秒）
 ∟ token string 事件 Token
 ∟ app_id string 应用 ID
 ∟ tenant_key string 租户 Key
event - -
 ∟operator object 创建人
 ∟ ∟union_id object 用户的 union id
 ∟ ∟user_id object 用户的 user_id 字段权限要求：获取用户ID
 ∟ ∟open_id object 用户的 open id
 ∟message object 事件中包含的消息内容
 ∟ ∟workflow_id string 工作流id
 ∟ ∟workflow_group_id string 工作流分组id
 ∟ ∟task_id string 任务id

# 事件体示例

{
  "header": {
    //示例值
    "event_id": "bbcce6e9-2ba4-4031-9b3c-8e610f3e0b73",
    "event_type": "workflow.subscribe",
    "create_time": "1662444442165",
    "token": "qwerasdfzxcv",
    "app_id": "bli_xxxxxxxxxxxxxxxxx",
    "tenant_key": "xxxxxxxxxxxxxxxxxxxx"
  },
  "event": {
    "operator": {
      //示例值
      "union_id": "on_123456789012345678901234567890",
      "user_id": "00000000",
      "open_id": "ou_123456789012345678901234567890",
      "staff_no": "00000000",
      "tenant_key": "qwerasdfzxcv"
    },
    "message": {
      //示例值
      "workflow_id": "qwerasdfzxcv",
      "workflow_group_id": "qwerasdfzxcv",
      "task_id": "qwerasdfzxcv"
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# 自定义字段变更

当任务字段变更时触发推送

基本
事件类型 workflow.message.task.field
支持的应用类型 自建应用
权限要求 [工作流]-[获取工作流事件变更]
字段权限要求 无
推送方式 webhook

# 事件体

名称 类型 描述
header event_header 事件头
 ∟ event_id string 事件 ID
 ∟ event_type string 事件类型 workflow.message.task.field
 ∟ create_time string 事件创建时间戳（单位：毫秒）
 ∟ token string 事件 Token
 ∟ app_id string 应用 ID
 ∟ tenant_key string 租户 Key
event - -
 ∟operator object 创建人
 ∟ ∟union_id object 用户的 union id
 ∟ ∟user_id object 用户的 user_id 字段权限要求：获取用户ID
 ∟ ∟open_id object 用户的 open id
 ∟message object 事件中包含的消息内容
 ∟ ∟workflow_id string 工作流id
 ∟ ∟workflow_group_id string 工作流分组id
 ∟ ∟task_id string 任务id
 ∟ ∟custom_fields_json string 任务当前自定义字段json

# 事件体示例

{
  "header": {
    //示例值
    "event_id": "bbcce6e9-2ba4-4031-9b3c-8e610f3e0b73",
    "event_type": "workflow.subscribe",
    "create_time": "1662444442165",
    "token": "qwerasdfzxcv",
    "app_id": "bli_xxxxxxxxxxxxxxxxx",
    "tenant_key": "xxxxxxxxxxxxxxxxxxxx"
  },
  "event": {
    "operator": {
      //示例值
      "union_id": "on_123456789012345678901234567890",
      "user_id": "00000000",
      "open_id": "ou_123456789012345678901234567890",
      "staff_no": "00000000",
      "tenant_key": "qwerasdfzxcv"
    },
    "message": {
      //示例值
      "workflow_id": "qwerasdfzxcv",
      "workflow_group_id": "qwerasdfzxcv",
      "task_id": "qwerasdfzxcv",
      "custom_field_json": "{\"field1\":\"f1\",\"field2\":\"f2\"}"
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# 新增评论

当任务被评论时触发推送

基本
事件类型 workflow.message.task.comment
支持的应用类型 自建应用
权限要求 [工作流]-[获取工作流事件变更]
字段权限要求 无
推送方式 webhook

# 事件体

名称 类型 描述
header event_header 事件头
 ∟ event_id string 事件 ID
 ∟ event_type string 事件类型 workflow.message.task.comment
 ∟ create_time string 事件创建时间戳（单位：毫秒）
 ∟ token string 事件 Token
 ∟ app_id string 应用 ID
 ∟ tenant_key string 租户 Key
event - -
 ∟operator object 创建人
 ∟ ∟union_id object 用户的 union id
 ∟ ∟user_id object 用户的 user_id 字段权限要求：获取用户ID
 ∟ ∟open_id object 用户的 open id
 ∟message object 事件中包含的消息内容
 ∟ ∟workflow_id string 工作流id
 ∟ ∟workflow_group_id string 工作流分组id
 ∟ ∟task_id string 任务id
 ∟ ∟comment_content string 评论内容文本
 ∟ ∟comment_img_key array 图片附件 数组
 ∟ ∟comment_file_url array 文件附件 数组

# 事件体示例

{
  "header": {
    //示例值
    "event_id": "bbcce6e9-2ba4-4031-9b3c-8e610f3e0b73",
    "event_type": "workflow.subscribe",
    "create_time": "1662444442165",
    "token": "qwerasdfzxcv",
    "app_id": "bli_xxxxxxxxxxxxxxxxx",
    "tenant_key": "xxxxxxxxxxxxxxxxxxxx"
  },
  "event": {
    "operator": {
      //示例值
      "union_id": "on_123456789012345678901234567890",
      "user_id": "00000000",
      "open_id": "ou_123456789012345678901234567890",
      "staff_no": "00000000",
      "tenant_key": "qwerasdfzxcv"
    },
    "message": {
      //示例值
      "workflow_id": "qwerasdfzxcv",
      "workflow_group_id": "qwerasdfzxcv",
      "task_id": "qwerasdfzxcv",
      "comment_content": "评论文本",
      "comment_img_key": ["key1","key2"],
      "comment_file_url": ["url1","url2"]
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# 任务状态变更

当任务状态发生变更时推送

基本
事件类型 workflow.message.task.status
支持的应用类型 自建应用
权限要求 [工作流]-[获取工作流事件变更]
字段权限要求 无
推送方式 webhook

# 事件体

名称 类型 描述
header event_header 事件头
 ∟ event_id string 事件 ID
 ∟ event_type string 事件类型 workflow.message.task.status
 ∟ create_time string 事件创建时间戳（单位：毫秒）
 ∟ token string 事件 Token
 ∟ app_id string 应用 ID
 ∟ tenant_key string 租户 Key
event - -
 ∟operator object 创建人
 ∟ ∟union_id object 用户的 union id
 ∟ ∟user_id object 用户的 user_id 字段权限要求：获取用户ID
 ∟ ∟open_id object 用户的 open id
 ∟message object 事件中包含的消息内容
 ∟ ∟workflow_id string 工作流id
 ∟ ∟workflow_group_id string 工作流分组id
 ∟ ∟task_id string 任务id
 ∟ ∟status int 任务当前状态 任务状态 1待认领，2进行中，3已完成

# 事件体示例

{
  "header": {
    //示例值
    "event_id": "bbcce6e9-2ba4-4031-9b3c-8e610f3e0b73",
    "event_type": "workflow.subscribe",
    "create_time": "1662444442165",
    "token": "qwerasdfzxcv",
    "app_id": "bli_xxxxxxxxxxxxxxxxx",
    "tenant_key": "xxxxxxxxxxxxxxxxxxxx"
  },
  "event": {
    "operator": {
      //示例值
      "union_id": "on_123456789012345678901234567890",
      "user_id": "00000000",
      "open_id": "ou_123456789012345678901234567890",
      "staff_no": "00000000",
      "tenant_key": "qwerasdfzxcv"
    },
    "message": {
      //示例值
      "workflow_id": "qwerasdfzxcv",
      "workflow_group_id": "qwerasdfzxcv",
      "task_id": "qwerasdfzxcv",
      "status": 1
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
最后更新于 : 7/4/2023, 10:04:00 AM

← 查询工作流信息 →