设置一个API触发器

InsightConnect的API触发器用于通过HTTP POST从外部应用程序触发工作流。通过生成自定义端点URL, API Trigger可以轻松集成和自动化提供webhook事件的工具。这也意味着您可以轻松地使用cURL或HTTP请求触发工作流。

在本文中,我们将介绍如何:

  1. 设置一个新的API触发器
  2. 需要API密钥认证
  3. 添加API触发器变量
  4. 使用cURL命令触发工作流

设置一个API触发器

要使用API触发器创建工作流,请遵循以下步骤:

  1. 转到任何工作流页面并单击蓝色添加工作流按钮在右上角
  2. 选择从头开始
  3. 输入工作流名称,并可选择输入描述、标记和手动完成的时间。
  4. 选择API触发选项从选择一个触发器菜单。
  5. 输入触发器的名称和描述。
  6. 如果需要,请检查需要API密钥认证盒子。
  7. 添加变量它将包含在你的触发事件中。
  8. 保存触发器配置。
  9. 复制您的触发器URL。
  10. 直接webhook, HTTP请求,和/或cURL命令到您的触发器URL!

需要API密钥验证

默认情况下,API触发器不需要身份验证。与每个API触发器关联的API端点通过在每个URL中使用惟一的、随机生成的uuid来提供隐藏,从而提供安全性。添加API密钥身份验证提供了额外的安全层,以防止不必要的或潜在的恶意事件触发您的工作流。

通过检查需要API密钥认证框中,您的触发器将需要一个X-API-Key身份验证头,以便处理传入的触发器事件。该字段的值必须是激活的用户组织您的Insight帐户的API密钥。

关于需要身份验证的注意事项

虽然许多支持webhook的应用和服务都支持添加自定义标题,但这并不是一个通用的特性。因此,我们建议在选择此选项之前确认你的webhook源代码支持添加自定义头。

如果您确实选择要求API触发器的API密钥身份验证,那么您的cURL命令使用以下格式:

         
旋度
1
-H "Content-Type: application/json" -d '{"taco":"bell", "burger":"king"}'

添加API触发器变量

当设置API触发器时,您可以定义将包含在触发器事件有效负载中的变量。通过这样做,将更容易构建您的工作流,因为您将能够使用这些变量作为步骤输入使用+菜单。

如果你不知道变量呢?

没烦恼!触发器将通过post发送的任何数据,因此只需从API触发器配置中删除所有变量并保存它。然后,激活工作流,触发HTTP请求(或等待源系统中发生事件),并在InsightConnect中找到生成的工作流Job。触发器输出将显示发送的所有变量。您甚至可以将输出视图切换为JSON,以复制所有变量,重新打开触发器,并使用进入JSON选项粘贴JSON主体。

使用cURL命令触发工作流

要使用cURL命令触发工作流,请使用- d——数据标记,以便将变量传递到您的工作流。例如:

         
旋度
1
-H "Content-Type: application/json" -d '{"taco":"bell", "burger":"king"}'