設定Webhook

記事番号:040600

在kintone中使用Webhook,當在kintone的應用程式中執行特定操作時,會將內容傳送給指定的外部服務。
例如,不必撰寫程式即可設定當新增記錄時,自動將內容發表在聊天室服務的整合功能。

Webhook的架構

將支援與許多服務整合的工具指定為Webhook的整合對象,即可將此類工具支援的各種服務與kintone整合。
支援整合的工具有Zapier、Microsoft Power Automate、IFTTT等。

示意圖:Webhook的架構

設定Webhook後,當有人在kintone的應用程式中執行以下操作時將會傳送通知。

  • レコードの追加
  • 編輯記錄
  • レコードの削除
  • 填寫回覆
  • 更新狀態(流程管理的狀態更新時)

關於在kintone中操作時的通知參數,請參閱以下頁面。
操作kintone時傳送的Webhook通知內容

設定流程

設定Webhook的步驟如下。

(1) 在整合支援工具(Zapier等)中設定觸發程序
(2) 在kintone中設定Webhook
(3) 透過整合支援工具設定動作

設定範例

以下使用Zapier說明「在kintone中新增記錄時向Gmail傳送通知」的設定範例。

事前準備

設定Webhook前,請準備以下項目。

  • 建立Gmail帳號
  • 建立kintone的應用程式

準備完成後,進行以下設定。

(1) 在Zapier中設定觸發程序

  1. 存取Zapier網站,點選[Sign up]建立新的Zapier帳號。
    若已經有Zapier帳號,點選[Log in]登入您的帳號。
    Zapier

  2. 點選Zapier網站上的[Create Zap]。

  3. 在觸發程序選擇畫面的搜尋欄中輸入「Webhook」,點選[Webhooks by Zapier]。截圖:選擇Webhook的觸發程序

  4. 在[Event]中選擇[Catch Hook],點選[Continue]。截圖:選擇[Catch Hook]

  5. 在接下來顯示的畫面中同樣點選[Continue]。截圖:顯示選擇[Event]後的畫面

  6. 此時會產生Webhook URL,點選[Copy]。
    請先將URL貼在文字編輯等程式中。截圖:框線強調[Copy]

接下來,在kintone中設定Webhook。請保持開啟Zapier的網頁。

(2) 在kintone中設定Webhook

  1. 在[記錄清單]畫面中,點選畫面右上方齒輪形狀的[設定應用程式]圖示。
    截圖:框線強調[設定應用程式]圖示

  2. 在[應用程式的設定]畫面中,點選[設定]分頁的[自訂/服務整合]中的[Webhook]。

  3. 在[Webhook]畫面中,點選[新增]。

  4. 在[新增Webhook]畫面中,輸入要設定的Webhook說明。
    輸入的說明將顯示在Webhook的設定清單畫面。最多可輸入64個字元。

  5. 在[Webhook URL]中,貼上「在Zapier中設定觸發程序」的步驟6中複製的URL。
    在Zapier中設定觸發程序
    貼上的URL不需要開頭的「https://」,請刪除。
    URL欄最多可輸入1,024個字元。截圖:顯示[新增Webhook]畫面

  6. 在[傳送通知的條件]中,指定要傳送Webhook通知的操作。
    此處勾選[新增記錄]。截圖:顯示[傳送通知的條件]

  7. 勾選[啟用此Webhook]。
    在初始設定中已勾選。

  8. 點選畫面右下方的[儲存]。

  9. 在[Webhook]畫面中,點選畫面上方顯示的訊息中的[應用程式的設定],或點選畫面左下方的[返回應用程式的設定]。

  10. 在[應用程式的設定]畫面中,點選[更新應用程式]。

  11. 在[更新應用程式]對話方塊中,點選[更新應用程式]。

  12. 在kintone的應用程式中新增記錄,測試在Zapier中設定的觸發程序。

  13. 回到Zapier網站中,點選[Test trigger]。
    截圖:顯示[Test trigger]畫面

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

(3) 在Zapier中設定動作

  1. 在顯示的Zapier動作設定畫面中,選擇[Gmail]。
    截圖:框線強調[Gmail]

  2. 在[Action Event]畫面中,對[Event]選擇[Send Email],點選[Continue]。
    截圖:對[Event]選擇[Send Email]

  3. 選擇Gmail帳號後,點選[Continue]。
    尚未登入Gmail時,將顯示是否允許登入Gmail的確認畫面。截圖:選擇Gmail的帳號

  4. 設定向Gmail傳送通知的內容。
    在[To]輸入收件的Gmail信箱,並設定[Subject]、[Body]等必要的內容後,點選[Continue]。
    截圖:設定向Gmail傳送通知的內容

  5. 確認設定內容後,點選[Test & continue]。

  6. 點選[Publish Zap]。

  7. 確認電子郵件已送達收件人的Gmail後,點選[Publish & Turn On]。

設定的Zap已啟用。

變更kintone的Webhook設定

kintone的Webhook設定內容可以之後再進行變更。步驟如下:

  1. 在[記錄清單]畫面中,點選畫面右上方齒輪形狀的[設定應用程式]圖示。
    截圖:框線強調[設定應用程式]圖示

  2. 在[應用程式的設定]畫面中,點選[設定]分頁的[自訂/服務整合]中的[Webhook]。

  3. 在[Webhook]畫面中,點選要變更設定的Webhook最右欄的[編輯]圖示。
    截圖:框線強調[編輯]

  4. 在[編輯Webhook]畫面中,編輯設定內容後,點選[儲存]。

  5. 在[Webhook]畫面中,點選畫面上方顯示的訊息中的[應用程式的設定],或點選畫面左下方的[返回應用程式的設定]。

  6. 在[應用程式的設定]畫面中,點選[更新應用程式]。

  7. 在[更新應用程式]對話方塊中,點選[更新應用程式]。