目次

目的

Web通知(Webhook)は、他のサービスやアプリケーションにデータを送信する仕組みです。システム的には、HTTPによってデータが送信されます。指定したURLに対して、指定したタイミングでデータを送信できます。Web通知(Webhook)の機能を通じて、Zoho Peopleのデータに追加や編集などの処理が実行された際に、他のサービスやアプリケーションにデータを送信して連携できます。データの送信先や内容はカスタマイズできます。送信の成功や失敗については、詳細を確認できます。

Web通知のメリット

  • 柔軟でカスタマイズできる
  • 他のサービスやアプリケーションと連携できる
  • データの送信先や内容を設定できる
  • データを同期できる
  • 処理結果を確認できる

Web通知の種類

  • Web通知の一覧:Web通知(Webhook)の機能を通じて、Zoho Peopleのデータを他のサービスやアプリケーションに送信できます(人事系のシステムの他、SlackやChatWorkなどのチャットサービスにメッセージを送信することも可能です)。
  • 失敗したWeb通知:処理が失敗したこととあわせて、Web通知の名前、フォーム名、関連するデータ、実行日時、処理結果のメッセージ等の詳細が表示されます。フォームやWeb通知名をもとに一覧からデータを抽出することも可能です。
  • 成功したWeb通知:処理が成功したこととあわせて、Web通知の名前、フォーム名、関連するデータ、実行日時、処理結果のメッセージ等の詳細が表示されます。フォームやWeb通知名をもとに一覧からデータを抽出することも可能です。

APIとは?

API(Application Programming Interface)は、外部のサービスやアプリケーションとの連携を可能にする仕組みです。Zoho PeopleのAPIでは、従業員をはじめとする様々なフォームのデータを取得、作成、編集、削除できます(データの形式:XML、JSON)。APIを通じて、他のサービスや自社システムとZoho Peopleを連携させることが可能です。

Web通知の項目

項目名詳細データの種類上限
名前Web通知の名前です。テキスト英数字(50)
詳細Web通知の詳細です。テキスト250文字
通知先のURLデータの送信先のURLです(例:Zoho People、Zoho Creator)。URL250文字
メソッドデータの送信方式です(POSTまたはGET)。標準ではPOSTが選択されています。ラジオボタン-
タブデータを送信する対象のフォームを選択します。選択肢-
タブの項目のパラメーターの追加送信するパラメーターの名前と値をタブの項目から選択して入力します。Web通知を通じて他のサービスやアプリケーションにデータが送信される際のパラメーターとして設定されます。文字列3000文字
独自のパラメーターの追加送信するパラメーターの名前と値を自分で入力します。Web通知を通じて他のサービスやアプリケーションにデータが送信される際のパラメーターとして設定されます。名前と値は設定された内容に応じて送信されます。認証用のトークンなど、固定の値を送信するために利用されます。文字列-
URLのプレビュー送信先のURLの内容をプレビューして確認できます。テキスト表示のみ

Web通知の設定

Web通知の設定はかんたんです。URLとパラメーターを入力し、ワークフローと関連付ければ完了します。Web通知を設定するには、次の手順にしたがってください:

  1. 管理者としてサインインしてください。
  2. 設定に移動してください。
  3. 自動化Web通知をクリックしてください。
  4. 新しいWeb通知をクリックしてください。
  5. Web通知の名前を入力してください。
  6. 詳細を入力してください。
  7. 通知先のURLを入力してください。
  8. メソッドを選択してください。POSTまたはGET
  9. フォーム名を選択してください。
  10. 送信するパラメーターの名前を入力してください。タブの項目から選択するパラメーターは10件まで設定できます。また、パラメーターを指定した形式で設定することも可能です。例:XML、JSONなど。独自の形式のパラメーター名と値を入力してください。独自のパラメーターは5件まで設定できます。

11.保存をクリックしてください。

利用例

Web通知を用いて、従業員のフォームと退職の詳細のフォームでデータを連動させる。

従業員が退職することになった場合に、退職日において該当の従業員のステータスを退職に変更し、退職の詳細を専用の管理フォームに入力するとします。退職の詳細を入力するフォームと従業員のデータを管理するフォームがある場合、通常はそれぞれでデータを入力・更新する必要があります。Web通知を用いることで、従業員のステータスが退職になったタイミングでワークフローを実行し、退職の詳細フォームに自動でデータを追加することができます。Web通知を設定するには、次の手順にしたがってください:

  1. 管理者としてサインインしてください。
  2. 設定に移動してください。
  3. 自動化Web通知をクリックしてください。
  4. 新しいWeb通知をクリックしてください。
  5. Web通知の名前を入力してください。
  6. 詳細を入力してください。
  7. 通知先のURLを入力してください。

https://people.zoho.com/people/api/forms/P_Separation/insertRecord

8.メソッドを選択してください。POST

9.フォーム名として従業員を選択してください。

10.独自の形式のパラメーターの名前を「xmlData」として設定し、値を以下のように設定してください:

  • <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>

11.独自のパラメーターとして、名前を「authtoken」と設定し、値にAPIの認証トークンを入力してください(あらかじめAPIの設定から取得しておく必要があります)。

12.保存をクリックしてください。

メモ:

上記のXMLのうち、「field」というタグはZoho Peopleの項目を表し、値の欄は送信するデータを表します。

独自のパラメーター

https://people.zoho.com/people/api/forms//insertRecord ?authtoken=XXXXXXXXXXXX&xmlData=

メモ:

Zoho PeopleのAPIを使用するには、認証トークンが必要です。認証トークンの取得方法については、関連するヘルプページを参照してください。