设置API触发器
InsightConnect的API触发器用于通过HTTP POST触发外部应用程序的工作流程。API触发器可以轻松集成和自动化为您提供自定义端点URL来提供Webhook事件的工具。这也意味着您可以轻松触发卷曲或HTTP请求的工作流程。
在本文中,我们涵盖了如何:
设置API触发器
要使用API触发器创建工作流程,请按照下列步骤操作:
- 转到任何工作流页面,然后单击蓝色添加工作流程右上方的按钮
- 选择白手起家。
- 输入工作流名称,然后选择手动输入描述,标签和时间以完成。
- 选择API触发器选项从“选择触发”菜单中。
- 输入触发器的名称和描述。
- 如果需要,检查需要API密钥身份验证盒子。
- 添加变量这将包含在触发事件中。
- 保存触发配置。
- 复制触发器URL。
- 将Webhooks,HTTP请求和/或卷曲命令直接连接到您的触发器URL!
需要API密钥身份验证
默认情况下,API触发器不需要身份验证。与每个API触发相关的API端点通过在每个URL中使用唯一的随机生成的uuid来提供安全性通过默默无闻。添加API密钥身份验证提供了一层附加的安全性,以防止不需要的或潜在的恶意事件触发您的工作流程。
通过检查需要API密钥身份验证框在触发配置菜单中,您的触发器需要一个X-API-key
身份验证标题才能处理传入的触发事件。此字段的值必须是活动的用户或者组织您的Insight帐户的API键。
关于需要身份验证的注释
虽然支持Webhooks支持添加自定义标题的许多应用和服务,但它不是一个通用功能。因此,我们建议在选择此选项之前确认您的Webhook源支持添加自定义标题。
如果您选择为API触发器要求API密钥身份验证,请使用以下格式进行CURL命令:
卷曲
1curl -x post -h“x-api-key:<插入api键这里>”-h“content-type:application / json”<插入API触发器URL> -d'{“taco”:“bell”,“汉堡王”}'
添加API触发变量
设置API触发器时,您可以定义将包含在触发事件有效载荷中的变量。通过这样做,建立工作流程将更容易,因为您将能够使用这些变量作为使用这些变量使用+菜单。
如果你不知道变量怎么办?
不用担心!触发器将通过帖子中发送的任何数据,因此只需从API触发配置中删除所有变量并保存。然后,激活工作流程,触发HTTP请求(或等待在源系统中发生事件),并在InsightConnect中找到生成的工作流作业。触发输出将显示发送的所有变量。您甚至可以将输出的视图切换为JSON复制所有变量,重新打开触发器,并使用输入json.选项粘贴json身体。
使用curl命令触发工作流程
要使用curl命令触发工作流程,请使用-D.
或者- 数据
标志为了将变量传递到您的工作流程中。例如:
卷曲
1curl -x post -h“x-api-key:<插入api键这里>”-h“content-type:application / json”<插入API触发器URL> -d'{“taco”:“bell”,“汉堡王”}'