設定Webhook

文章編號:040600

在kintone中使用Webhook,當在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」的網站並登入。
    若沒有Zapier帳號,請建立新帳號或用Google等帳號登入。

  2. 點擊Zapier網站上的[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的網頁。

在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. 在kintone的應用程式中新增記錄,測試透過Zapier設定的觸發程序。

  12. 返回Zapier網站,點擊[Test trigger]。
    Zapier的網站

  13. 確認測試成功後,點擊[Continue]。
    測試未成功時,請多試幾次[Test trigger]。
    若仍測試失敗,請確認Webhook URL中複製貼上的URL是否有誤。

在Zapier中設定動作

  1. 在顯示的Zapier動作設定畫面中,選擇Gmail。 Zapier設定畫面

  2. 在Action Event中選擇「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. 在確認對話方塊中點擊[更新應用程式]。