Webhook与连接器

名词解释

1、webhook 用于被动接受外部请求，由外部请求来触发本系统的服务;

2、连接器 用于主动发起请求，触发外部服务(大部分情况下是通过开发接口或外部提供的webhook);

功能限制

1、webhook 目前支持使用http/https和feign协议进行调用，其中feign仅支持新核云内部调用;

2、连接器 目前仅支持使用http/https协议进行外部请求;

使用文档

请联系相关人员获取CorePaaS平台工作流引擎使用文档;

webhook调用

前提: 在CorePaaS平台工作流引擎中配置了webhook触发器流程，并获取其hashName(租户下webhook流程的唯一标识)。

BASIC

Method: POST

Path: /api/metadata-flow/trigger/webhook/{hashName}

REQUEST

路径变量:

name	value	desc
hashName		webhook触发标识

请求示例:

webhook接口的传参为Object（没有固定的格式，需要与webhook触发器的配置保持一致）

{
  "string": "文本",
  "number": 123,
  "boolean": false,
  "array": ["选项一","选项二"]
}

RESPONSE

响应参数:

参数名称	格式	说明
code	Integer	状态码
message	String	响应信息
data	Object	响应内容
entity	List	本次操作成功返回的数据

响应示例:

{
    "code": 200,
    "message": "ok",
    "data": {}
}

连接器调用

前提: 在CorePaaS平台工作流引擎的流程中配置了连接器节点。

调用: 流程引擎正常执行到对应的连接器节点，会根据节点配置自动调用外部请求。