设置Webhook

文章编号:040600

在kintone中使用Webhook,可在对kintone的应用进行特定的操作时,将其内容发送至指定的外部服务。
例如,无需编程即可设置类似于在发生记录添加时将其内容发送至聊天工具的整合。
仅可在kintone标准版中使用Webhook。

Webhook的机制

将用于整合多种网络服务的工具指定为Webhook的整合对象,即可将其所支持的服务与kintone进行整合。
用于整合网络服务的工具有:Zapier、Microsoft Power Automate、IFTTT等。

插图:Webhook的机制

设置Webhook后,当kintone应用中发生以下操作时可收到通知:

  • 添加记录
  • 编辑记录
  • 删除记录
  • 填写回复
  • 更新状态(流程管理的状态被更新时)

关于kintone中发生操作的通知参数,请参考“kintone发生操作时发送的Webhook的通知内容”。

Webhook的设置流程

按照以下流程设置Webhook。

  • 在集成辅助工具(如Zapier)中设置触发器
  • 在kintone中设置Webhook
  • 在整合支援工具中设置动作

设置示例

此处以使用Zapier,设置“当kintone中发生记录添加时向Gmail发送通知”为例进行说明。

预先准备

在进行Webhook的整合设置前,请进行以下准备:

  • 创建Gmail账号
  • 创建kintone的应用

完成准备后,进行以下设置:

在Zapier中设置触发器

  1. 访问“Zapier”的Web网站,并进行注册。
    没有Zapier账号时,请创建账号或使用Google等账号注册。

  2. 点击Zapier的Web网站中的[Create Zap]。

  3. 在触发器选择页面中的搜索框中输入“Webhook”,点击“Webhooks by Zapier”。 Zapier设置页面

  4. 在“Event”中选择“Catch Hook”,点击[Continue]。 Zapier设置页面

  5. 以下页面中,也直接点击[Continue]。 Zapier设置页面

  6. 生成Webhook URL后,点击[Copy]。
    请将URL粘贴至文本编辑器中。 Zapier设置页面

接下来在kintone中设置Webhook。请暂时不要关闭Zapier的Web页面。

在kintone中设置Webhook

  1. 在kintone中打开Webhook的设置页面。
    点击记录列表页面右上方的齿轮状应用设置图标,选择“设置”标签中的“自定义/服务整合”的[Webhook]。
    应用设置图标

  2. 点击[添加]。

  3. 输入要设置的Webhook的说明。
    输入的说明将显示在Webhook设置的列表页面。最多可输入64个字符。

  4. 将“在Zapier中设置触发器”的步骤6中复制的URL粘贴至Webhook URL中。
    所粘贴的URL无需开头的“https://”,请删除。
    URL栏中最多可输入1,024个字符。 Webhook设置的列表页面

  5. 发送通知的条件中指定要发送Webhook通知的操作。
    本例中勾选“添加记录”。 Webhook设置的列表页面

  6. 勾选“启用此Webhook”。
    初始设置为勾选状态。

  7. 点击页面右下方的[保存]。

  8. 点击页面上方弹出信息中的[应用的设置]或页面左下方的[返回应用的设置]。

  9. 点击页面右上方的[更新应用]。

  10. 在确认对话框中点击[更新应用]。

  11. 为了对Zapier中设置的触发器进行测试,在kintone的应用中添加新的记录。

  12. 返回Zapier的Web网站,点击[Test trigger]。
    Zapier的Web网站

  13. 确认测试成功后,点击[Continue]。
    如未成功,请多次点击[Test trigger]进行尝试。
    如依然失败,请确认Webhook URL中复制粘贴的URL是否有误。

在Zapier中进行动作设置

  1. 显示Zapier的动作设置后,选择Gmail。 Zapier设置页面

  2. 动作事件选择“Send Email”,点击[Continue]。
    Zapier设置页面

  3. 选择Gmail账号,点击[Continue]。
    未登录Gmail时,将显示确认允许登录Gmail的页面。 Zapier设置页面

  4. 设置发送至Gmail的通知内容。
    “To”中输入要接收通知的Gmail地址,在Subject、Body等处设置必要的内容后,点击[Continue]。
    Zapier设置页面

  5. 确认设置内容,点击[Test & continue]。

  6. 点击[Publish Zap]。

  7. 确认收件人的Gmail中已收到邮件,点击[Publish & Turn On]。

已启用所设置的Zap。

更改kintone的Webhook的设置

可之后更改kintone的Webhook的设置内容。操作步骤如下所示:

  1. 点击想要更改设置的Webhook最右列的“编辑”图标。
    更改Webhook的设置

  2. 编辑设置内容,点击[保存]。

  3. 点击页面上方弹出信息中的[应用的设置]或页面左下方的[返回应用的设置]。

  4. 点击页面右上方的[更新应用]。

  5. 在确认对话框中点击[更新应用]。