Zoho PeopleのWebhook
Webhookとは
この機能を使用すると、特定の処理が実行されたときの、外部アプリへのリアルタイムのデータ転送や通知を自動化できます。ユーザーがZoho Peopleで処理を実行するたびに、指定したURLに通知が送信されることで、遅延なく最新の情報を把握できます。また、 外部アプリと効率的に連携が可能です。
Webhookはユーザー定義の「HTTPコールバック」とも呼ばれ、HTTP POST経由で送信される自動イベント通知として機能します。あらかじめ設定した処理が実行されるたびに、指定されたURLにメッセージを配信して通知します。
Webhookの設定
- サービス内のフォームに対して独自のWebhookを作成して、新規または既存のワークフローに関連付けます。
- ワークフローで特定の操作が行なわれると、Webhookが実行され、Zoho Peopleから外部アプリに自動通知が送信されます。
Webhookのメリット
- 柔軟にカスタマイズできる
- 外部アプリに即時通知を送信できる
- 独自アプリや外部アプリと連携できる
- リアルタイムにデータを同期できる
- 処理結果を確認できる
Webhookの種類
- Webhookの一覧：ユーザーがZoho Peopleアカウントで操作を行うたびに、外部アプリに対して通知を送信できます。
- 失敗したWebhook：Webhook名、フォーム名、関連データ、最新の呼び出し時間、処理の再実行、処理結果のメッセージといった詳細とともに、このページに一覧表示されます。また、フォーム名、Webhook名、期間などを指定して、データを抽出することも可能です。
- 成功したWebhook：Webhook名、フォーム名、関連データ、最新の呼び出し時間、処理の再実行、処理結果のメッセージといった詳細とともに、このページに一覧表示されます。また、フォーム名、Webhook名、期間などを指定して、データを抽出することも可能です。
APIとは
Zoho Peopleでは、外部アプリケーションと連携を行うにあたってAPIを利用できます。APIを利用すると、従業員やフォームのデータをXMLまたはJSON形式のファイルで抽出することが可能です。このファイルをもとに、新しいアプリケーションを開発したり、外部アプリケーションと連携したりすることができます。Zoho PeopleのAPIでは、あらゆるプログラミング言語（Java、.Net、C、C++、PHP）でアプリケーションを開発できます。
詳細については、こちらをクリックしてください。
Webhookの項目
| 項目名 | 説明 | データの種類 | 上限 |
| Webhook名 | Webhookの名前 | テキスト | 英数字（50文字） |
| 説明 | Webhookの説明 | テキスト | 250文字 |
| 通知先のURL | 外部アプリまたはZohoのアプリのAPIとURLを指定します（例：Zoho People、Zoho Creator）。 | URL | 250文字 |
| メソッド | APIメソッドの種類（POSTまたはGET）を選択します。標準ではPOSTが選択されています。 | ラジオボタン | ー |
| モジュール | 外部アプリにデータを送信する「フォーム」を選択します。 | 選択リスト | ー |
| フォームの項目の追加 | ［パラメーターの名前］と対応する［パラメーターの値］に入力します。これは、外部アプリにWebhookを実行する間に送信されるリクエストのパラメーターです。 | 文字列 | 3,000文字 |
| 独自のパラメーターの追加 | Webhook用のパラメーター名と対応する値を指定します。これは、Webhookを実行する際に送信されるリクエストのパラメーターでもあります。名前と値は設定どおりです。このキーと値のペアは、主に認証トークンやセキュリティトークンを送信するために使用されます。 | 文字列 | ー |
| URLのプレビュー | 外部アプリに通知されるWebhook URL全体をプレビューします。 | テキスト | 表示のみ |
Webhookの設定
Webhookの機能はシンプルで、容易に設定できます。HTTP URLを設定し、ワークフロールールに関連付けるだけで、ワークフローの処理を自動化できます。任意のサービスにWebhookを設定するには、以下の手順に従ってください。
- ［設定］→任意のサービス→［自動化］→［操作］→［Webhook］の順に移動します。
- ［Webhookを追加する］をクリックします。
- Webhookの設定ページでは、以下の手順に従って設定します。
- 変更イベント発生時にWebhookを実行するサービス内のフォームを選択します。
- ［Webhook名］を入力します。
- ［通知先のURL］を指定します。
- ［説明］（Webhookの使用目的）を入力します。
- APIメソッドを［POST］または［GET］から選択します。
- 必要なクエリーパラメーターの指定
［パラメーターの名前］と対応する［パラメーターの値］を指定します。ユーザー定義の形式でパラメーターを指定すると、最大10件のエンティティ項目をパラメーターとして追加できます。例：XML、JSONなど、独自のパラメーター名とパラメーター値を指定します。独自のパラメーターは、最大5件まで追加できます。
-
［保存する］をクリックします。
Webhookが保存され、ワークフローにタグ付けできるようになります。
Webhookとワークフローの関連付け
Webhookを実行する条件を持つワークフローを作成して、Webhookをワークフローに関連付けます。
Webhookをワークフローに関連付けるには
- ［設定］→任意のサービス→［自動化］→［ワークフロー］→［ワークフローを追加する］の順に移動します。
- 入力が必要な項目すべてに入力します。
- ［操作］で［Webhook］欄にある［+］（追加）アイコンをクリックして、ワークフローに新しいWebhookを追加するか、フォームに作成された既存のWebhookを選択します。
- ［追加する］をクリックします。
ワークフローが追加されます。特定の操作が行われると、Webhookが実行され、外部アプリに通知が送信されます。
利用例
Webhookによる退職フォームの従業員ステータス変更
ある従業員が退職することになり、従業員フォームのステータスを「退職」に変更する場合の手順です。Webhook導入前は、従業員フォームと退職フォームの両方で変更を手動で更新する必要がありました。しかし、APIを使用してWebhookを設定すると、従業員フォームでの変更が退職フォームに通知され、自動で更新できるようになります。この利用例でWebhookを設定するには、以下の手順に従ってください。
- ［設定］→任意のサービス→［自動化］→［操作］→［Webhook］の順に移動します。
- ［Webhookを追加する］をクリックします。
- Webhookの設定ページでは、以下の手順に従って設定します。
- ［フォーム名］のドロップダウンを使用して、従業員フォームを選択します。
- ［Webhook名］を入力します。
- ［通知先のURL］を以下のように入力します。
-
［説明］を入力します。
-
APIメソッドの種類は［POST］を選択します。
- 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タグは送信されるデータを表しています。 - 独自のパラメーターを入力します。authtokenをパラメータ名、authtokenキーをパラメータ値に指定します。
APIを使用するには、Zoho Peopleアカウントの認証トークンが必要です。Zoho PeopleのAPIガイドについては、こちらをクリックしてください。 - ［保存する］をクリックします。
このWebhookをワークフローに関連付けて、実行条件とする処理を定義します。
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho Campaigns Resources
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
Zoho PeopleのZoho Invoice連携
Zoho PeopleのZoho Invoice連携 Zoho PeopleとZoho Invoiceを連携することで、Zoho Peopleの工数表などのデータを、Zoho Invoiceに同期し、請求書関連の処理をかんたんに行うことができるようになります。 Zoho Invoiceと連携するには ホーム画面から［設定］→［マーケットプレイス］→［Zoho］→［Zoho Finance Suite］（Zohoの会計サービス）→［詳細を表示する］の順に移動します。 Zoho ...Zoho People Kiosk
Zoho People Kioskとは Zoho People Kioskを使用すると、出退勤情報を就業場所（現場）で管理できます。従業員は、スマートフォンなどのカメラで自身の写真を撮影するだけで、顔認証で出退勤を記録できます。かんたんな設定で、プロジェクト先のオフィスの受付などで使用できます。また、リモートオフィスや倉庫などで働く従業員の出退勤情報の管理にも役立ちます。 Zoho People Kioskの設定 ［設定］→［出退勤］→［設定］→［キオスク設定］の順に移動します。 Zoho ...接続 - Zoho People
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho People コネクションは、Zoho ...Zoho PeopleとのZoho Mail統合
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho Mail 連携 Zoho PeopleとZoho Mailの連携により、Zoho MailユーザーをZoho Peopleと簡単に同期できます。この連携を利用すると、従業員を個別にアカウントへ追加する手間が省け、時間を大幅に節約できます。任意の数のZoho ...Zoho ProjectsとZoho Peopleの統合
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 目的 Zoho PeopleとZoho Projectsの連携機能を利用すると、以下のことが可能です。 Zoho ProjectsからZoho Peopleにプロジェクト、タスク、工数表を手動または自動でインポートできます。また、承認日時ログをZoho PeopleからZoho ...