创建触发事件

前提条件

已创建连接器。

操作步骤

1. 在“我的连接器”列表中，单击连接器名称，选择“触发事件”页签，单击“创建触发事件”。
2. 设置触发事件基本信息，具体的参数说明如表1所示。

   表1 参数说明

   参数	说明
   名称	填写触发事件的名称，根据规划自定义。建议您按照一定的命名规则填写触发事件的名称，方便您快速识别和查找。 触发事件是用于启动工作流的事件，建议您命名为“当......时”。比如，“当收到电子邮件时”，“当创建表格时”。
   描述	触发事件的描述信息。
   类型	轮询，轮询间隔的输入值必须在1到10080之间（单位分钟）。选择后请执行3~5。 Webhook，选择后请执行6。

3. 单击“下一步”，设置触发事件的请求信息，具体参数如表2所示。

   表2 参数说明

   参数	说明
   接口路径	被调用API的请求方式及请求路径。
   输入参数	配置请求参数，如被调用API没有请求参数可不填。 请求头（Header）：HTTP请求消息的组成部分之一，请求头负责通知服务器有关于客户端请求的信息。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表3。 请求体（Body）：HTTP请求消息的组成部分之一，请求体呈现发送给服务器的数据。 单击“导入”：可直接粘贴被调用API的JSON、JSON Schema或XML数据批量导入参数，减少逐个配置参数的工作量。 说明： 如果请求体使用XML格式，XML header参数必须配置。 单击“复制”：复制请求体参数的JSON或XML数据。 单击“预览”：可以预览参数的JSON或XML结构。 单击参数列表“操作”列的：可选择是否开启“是否支持根节点输入”参数，开启并发布对应连接器后，在创建流中添加该触发事件时可以自定义请求体参数的值。 单击参数列表“操作”列的：新增参数，参数配置说明请参见表3。 查询参数（Query）：查询参数会追加到URL。例如，在 /items?id=#### 中，查询参数为ID。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表3。 路径参数（Path）：路径与路径模板一起使用，其中参数值实际上是操作URL的一部分。

   表3 参数配置说明

   参数	说明
   参数名称	输入参数的名称。
   显示字段	输入该参数的别名。
   必填	勾选该参数是否是用户必填项。
   参数类型	选择参数类型，支持string、number、boolean、integer类型。
   说明	关于参数的介绍说明。
   操作	单击：配置参数在界面的显示样式。配置完成并发布对应连接器后，在创建流中添加该触发事件时可以查看参数的界面显示效果。 参数类型：选择参数类型，支持string、number、boolean、integer类型。 格式：设置用户输入该参数时界面显示的样式，可选择文本框、密码、日期时间、富文本、下拉列表。不同的参数类型可选择的格式不同。 说明： 当格式选择为下拉列表时，需设置分隔符和下拉列表的值。其中，分隔符只能输入单个特殊字符，如“$”、“%”、“^”、“&”等，不设置时，默认为“,”；下拉列表的值不能和分隔符一致，支持设置多个值，单击“新增”可进行添加。 设置完成后，如果勾选了“支持多选”，则可在创建流中添加该触发事件时选择多个值，否则，只能选择一个值。 可见性：设置用户输入该参数时界面显示的可见性。无：在界面中正常显示；高级：默认隐藏在高级菜单里；隐藏：该参数向用户隐藏；重要：优先显示在界面的最开始。 默认值：设置该参数的预设值。 单击：新增节点。 单击：删除该节点。

4. 单击“下一步”，添加响应信息，具体参数如表4所示。

   表4 参数说明

   参数	说明
   添加响应	根据被调用API的响应码信息添加响应码。
   输出参数	配置响应参数，如被调用API没有响应参数可不填。 响应头：HTTP响应消息的组成部分之一，响应头负责通知服务器有关于客户端请求的信息。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表3。 响应体：HTTP响应消息的组成部分之一，响应体呈现发送给服务器的数据。 单击“导入”：可直接粘贴被调用API的JSON、JSON Schema或XML数据批量导入参数，减少逐个配置参数的工作量。 说明： 如果响应体使用XML格式，XML header参数必须配置。 单击“复制”：复制请求体参数的JSON或XML数据。 单击“预览”：可以预览参数的JSON或XML结构。 单击参数列表“操作”列的：新增参数，参数配置说明请参见表3。

5. 单击“下一步”，配置轮询参数，具体参数如表5所示。添加完成后，执行7。

   表5 参数说明

   参数	说明
   轮询触发条件	设置轮询触发条件后，满足该条件时，会触发流运行。 当轮询结果中字段类型为对象或者数据的字段的返回值存在时（对象下存在属性，数组长度不为空），会触发流运行。
   输入参数	通过3配置的请求参数，显示的轮询参数信息。 默认值：设置该参数的预设值。如果已在3中配置了请求参数的默认值，此处无需设置。 参数值：设置轮询的参数值。可根据所需选择轮询结果或内置函数。

6. 单击“下一步”，设置触发事件的请求信息，具体参数如表6所示。

   表6 参数说明

   参数

   说明

   输入参数

   配置请求参数，如被调用API没有请求参数可不填。 请求头（Header）：HTTP请求消息的组成部分之一，请求头负责通知服务器有关于客户端请求的信息。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表3。 请求体（Body）：HTTP请求消息的组成部分之一，请求体呈现发送给服务器的数据。 单击“导入”：可直接粘贴被调用API的JSON、JSON Schema或XML数据批量导入参数，减少逐个配置参数的工作量。 说明： 如果请求体使用XML格式，XML header参数必须配置。 单击“复制”：复制请求体参数的JSON或XML数据。 单击“预览”：可以预览参数的JSON或XML结构。 单击参数列表“操作”列的：新增参数，参数配置说明请参见表3。 查询参数（Query）：查询参数会追加到URL。例如，在 /items?id=#### 中，查询参数为ID。 单击参数列表“操作”列的可以新增参数，参数配置说明请参见表3。

   表7 参数配置说明

   参数	说明
   参数名称	输入参数的名称。
   显示字段	输入该参数的别名。
   必填	勾选该参数是否是用户必填项。
   参数类型	选择参数类型，支持string、number、boolean、integer类型。
   说明	关于参数的介绍说明。
   操作	单击：配置参数在界面的显示样式。配置完成并发布对应连接器后，在创建流中添加该触发事件时可以查看参数的界面显示效果。 参数类型：选择参数类型，支持string、number、boolean、integer类型。 格式：设置用户输入该参数时界面显示的样式，可选择文本框、密码、日期时间、富文本、下拉列表。不同的参数类型可选择的格式不同。 说明： 当格式选择为下拉列表时，需设置分隔符和下拉列表的值。其中，分隔符只能输入单个特殊字符，如“$”、“%”、“^”、“&”等，不设置时，默认为“,”；下拉列表的值不能和分隔符一致，支持设置多个值，单击“新增”可进行添加。 设置完成后，如果勾选了“支持多选”，则可在创建流中添加该触发事件时选择多个值，否则，只能选择一个值。 可见性：设置用户输入该参数时界面显示的可见性。无：在界面中正常显示；高级：默认隐藏在高级菜单里；隐藏：该参数向用户隐藏；重要：优先显示在界面的最开始。 默认值：设置该参数的预设值。 单击：新增节点。 单击：删除该节点。

7. 设置完成后，单击“保存”。
   

   如果触发事件类型是Webhook，参数配置完成后，单击“保存草稿”。

8. 测试触发事件。测试触发事件前需要先发布连接器。
   1. 在界面右上方单击“发布”发布连接器，系统自动弹出发布的提示框，单击“确定”。
   2. 单击“操作”列的“测试”进入测试界面。
   3. 在“测试”界面中，配置相关参数。
      • 当触发事件类型为“轮询”时，配置输入参数。如果没有创建连接，请先创建连接。配置完成后单击“提交测试”。
        

        如果该连接器采用“无验证”方式，则无需配置连接。

      • 当触发事件类型为“Webhook”时，单击“获取URL”获取Webhook URL。获取后用户需要复制该URL，并进行手动调用。调用该URL后，返回测试界面，界面右侧会显示调用结果。
        

        获取的URL有效期为1分钟，有效期内仅支持一次调用，调用或超时后入请重新获取及调用。

   4. 测试完成后，可查看测试结果和测试历史。
      • 如果测试通过，表示触发事件创建完成。
      • 如果测试不通过，您可以单击“操作”列的“编辑”修改触发事件。修改完成后单击界面右上方“发布”重新发布连接器，再对该触发事件进行测试。

9. （可选）触发事件创建完成后，连接器需要发布后才能在流编排中使用该触发事件，具体请参见发布连接器。

更多操作

触发事件创建完成后，您可以执行如表8的操作。