Webhookとは

Webhookのメリット

1. 柔軟にカスタマイズできる
   
2. 外部アプリに即時通知を送信できる
   
3. 独自アプリや外部アプリと連携できる
   
4. リアルタイムにデータを同期できる
   
5. 処理結果を確認できる
   

Webhookの種類

1. Webhookの一覧：ユーザーがZoho Peopleアカウントで操作を行うたびに、外部アプリに対して通知を送信できます。
   
2. 失敗したWebhook：Webhook名、フォーム名、関連データ、最新の呼び出し時間、処理の再実行、処理結果のメッセージといった詳細とともに、このページに一覧表示されます。また、フォーム名、Webhook名、期間などを指定して、データを抽出することも可能です。
   
3. 成功したWebhook：Webhook名、フォーム名、関連データ、最新の呼び出し時間、処理の再実行、処理結果のメッセージといった詳細とともに、このページに一覧表示されます。また、フォーム名、Webhook名、期間などを指定して、データを抽出することも可能です。

APIとは

Webhookの項目

Webhookの設定

1. ［設定］→任意のサービス→［自動化］→［操作］→［Webhook］の順に移動します。
   
2. ［Webhookを追加する］をクリックします。
   
3. Webhookの設定ページでは、以下の手順に従って設定します。
   
4. 変更イベント発生時にWebhookを実行するサービス内のフォームを選択します。
   
5. ［Webhook名］を入力します。
   
6. ［通知先のURL］を指定します。
   
7. ［説明］（Webhookの使用目的）を入力します。
   
8. APIメソッドを［POST］または［GET］から選択します。
   
9. 必要なクエリーパラメーターの指定
   
   

   ［パラメーターの名前］と対応する［パラメーターの値］を指定します。ユーザー定義の形式でパラメーターを指定すると、最大10件のエンティティ項目をパラメーターとして追加できます。例：XML、JSONなど、独自のパラメーター名とパラメーター値を指定します。独自のパラメーターは、最大5件まで追加できます。
   
   
   
10. 必要に応じて、カスタムHTTPヘッダーを追加します。カスタムHTTPヘッダーを追加することにより、リクエストヘッダー内で認証トークン、セキュリティトークン、APIキー、その他の認証情報を安全に送信できます。
    
11. URLのプレビューを確認します。URLの更新ボタンをクリックすると、URLを更新できます。
    
12. ［保存する］をクリックします。
    Webhookが保存され、ワークフローにタグ付けできるようになります。

Webhookとワークフローの関連付け

利用例

Webhookによる退職フォームの従業員ステータス変更

ある従業員が退職することになり、従業員フォームのステータスを「退職」に変更する場合の手順です。Webhook導入前は、従業員フォームと退職フォームの両方で変更を手動で更新する必要がありました。しかし、APIを使用してWebhookを設定すると、従業員フォームでの変更が退職フォームに通知され、自動で更新できるようになります。この利用例でWebhookを設定するには、以下の手順に従ってください。

1. ［設定］→任意のサービス→［自動化］→［操作］→［Webhook］の順に移動します。
   
2. ［Webhookを追加する］をクリックします。
   
3. Webhookの設定ページでは、以下の手順に従って設定します。
   
4. ［フォーム名］のドロップダウンを使用して、従業員フォームを選択します。
   
5. ［Webhook名］を入力します。
   
6. ［通知先のURL］を以下のように入力します。
   

   

   https://people.zoho.com/people/api/forms/P_Separation/insertRecord
7. ［説明］を入力します。
8. APIメソッドの種類は［POST］を選択します。
   
9. URLクエリーパラメーターを以下のように入力します。
   

   

   ユーザー定義のフォーマットの場合：パラメータ名「xmlData」と値「Description」を以下のように指定します。
   

   <Request>

   <Record>

   <field name='Employee_ID'>${ZOHO_LINK_ID}</field>

   <field name='Interviewer'>${Reporting_To}</field>

   <field name='Separation_date'>${Exit_Date}</field>

   </Record>

   </Request>
   

   

   上記のXML文字列では、tag fieldはZoho Peopleの項目、nameは項目のラベル名、valueタグは送信されるデータを表しています。
10. 独自のパラメーターを入力します。authtokenをパラメータ名、authtokenキーをパラメータ値に指定します。
    

    

    APIを使用するには、Zoho Peopleアカウントの認証トークンが必要です。Zoho PeopleのAPIガイドについては、こちらをクリックしてください。
11. ［保存する］をクリックします。
    

このWebhookをワークフローに関連付けて、実行条件とする処理を定義します。