お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Webhookは、Zoho Recruitでイベントが発生するたびにWeb通知を即時送信し、外部のアプリケーションとの連携を可能にします。WebhookではHTTP URLを設定し、ワークフローのルールに関連付けることで、通知プロセス全体を自動化できます。

利用例

• Zoho RecruitのWebフォームを使用してWebサイトから収集した候補者や連絡先を基準に、メールマーケティング（一括メール送信）ソフトウェア（例：MailChimp）のメーリングリストに購読者を追加できます。
• 面接担当者や候補者にイベントを通知するSMSリマインダーを送信できます。

対象ユーザー

• ワークフロー管理権限を持つRecruitユーザー
• REST APIのスキルを持つプログラマー

利用条件

必要な権限：ワークフロー管理権限を持つユーザーが、この機能にアクセスできます。

Webhookの項目の一覧

Webhookの設定

Webhookの設定には、次の3つの手順が含まれます。

• Webhookを作成します。
• Webhookをワークフローのルールに関連付けます。
• Webhook連携をテストします。

Webhookを作成するには

1. ［設定］→［自動化］→［処理］→［Webhook］に移動します。
2. Webhookページで、［Webhookの設定］をクリックします。
3. 新しいWebhookページで、必要なパラメーターをすべて指定します。
4. ［保存する］をクリックします。
   

サポートされていない差し込み項目の値の確認

Webhookの［値の詳細］エディターで使用していた差し込み項目の値が、${Unsupported_Field}と表示される場合があります。これが発生する主な理由は次のとおりです。

カスタム項目の削除

値を挿入した差し込み項目が削除されています。Webhookの［値の詳細］エディターに削除済み項目の差し込み項目の値が残っている場合、その値は${Unsupported_Field}と表示されます。

カスタムルックアップ項目の削除

値を挿入したカスタムルックアップ項目が削除されています。Webhookの［値の詳細］エディターに削除済みルックアップ項目の差し込み項目の値が残っている場合、その値は${Unsupported_Field}と表示されます。

利用可能な差し込み項目の一覧に表示されていない項目

選択したタブの利用可能な差し込み項目の一覧に含まれていない項目の差し込み項目の値を使用した場合、その値は${Unsupported_Field}と表示されます。
たとえば、［求人］のタブの［値の詳細］エディターに差し込み項目の値${Candidates.Candidate Id}を挿入すると、その値はサポートされていない項目として表示されます。

Webhookをワークフローのルールに関連付けるには

1. ［設定］→［自動化］→［処理］→［ワークフローのルール］に移動します。
2. ［ワークフローのルール］ページで、［ルールの作成］をクリックします。
3. ［新しいルールの作成］ページで、ワークフローのルールのパラメーターを指定します。
4. ［ワークフローの処理］で、［Webhook］を選択します。
5. ［Webhookの呼び出し］ポップアップで、必要なWebhookを選択し、［関連付ける］をクリックします。
6. ［保存する］をクリックします。
   

Webhook連携をテストするには

1. ワークフローのルールの条件に従って、Zoho Recruitにテストデータを追加します。
2. 使用しているアプリケーションで、Webhook通知を通じてZoho Recruitから受信したデータを確認します。
3. エラーやデータの不一致がある場合は、Zoho RecruitでWebhookの設定を修正します。
4. 使用しているアプリケーションでZoho Recruitから必要なデータを取得できるまで、このテストを続けます。

重要事項

• 1件のワークフローのルールにつき、最大6件（1件のすぐに実行する処理と5件の時間基準の処理）のWebhookを関連付けられます。
• Webhookを使用して、Zoho Recruitから外部のアプリケーションへ最大10件のZoho Recruit項目のデータを転送できます。
• Webhookを使用して、その他のサービスからZoho Recruitへデータを取得することはできません。
• 外部のアプリケーションの制限に応じて、APIチケットを定期的に更新する必要があります。
• 外部APIの問題によりWebhook連携が停止した場合、メール通知は送信されません。
• Webhookでは、POST方式を使用する場合、ユーザー定義フォーマットの上限は10,000文字です。
• 処理中に失敗が発生した場合、まずWebhookから通知が送信されます。Zoho Recruitのシステムから15分後に2回目の通知が送信されます。その後、該当するワークフローのトリガーに対するWebhook通知は送信されません。
• 1日あたりの上限数を超えた場合、システムは残りのWebhook通知を外部のアプリケーションに送信せず、管理者に失敗を通知します。
• ［通知先のURL］項目でポート番号を指定する場合、サポートされているポート番号は80または443のみです。
• Zoho Recruitでは、Webhookパラメーターの設定時に、必要な日付／日時フォーマットとタイムゾーンを選択できます。
• Webhookの制限。
• プロフェッショナルプラン-10,000件／日、またはユーザーライセンスあたり100件（いずれか少ない方）。
• エンタープライズプラン-20,000件／日、またはユーザーライセンスあたり200件（いずれか少ない方）。
  

ビジネスシナリオ

一括採用が行われ、すべての面接担当者にSMS通知を送信する必要があります。この業務フローはWebhookを使用して簡略化できます。

目的

予定されている面接について、面接担当者にSMSで通知します。

前提条件

• SMSゲートウェイサービスのアカウント
• ワークフローのルールにアクセスする権限

手順

1. SMSゲートウェイサービスでアカウントを作成する
2. Zoho RecruitでWebhookを設定する
3. ワークフローのルールを設定する
4. Webhook連携をテストする

SMSゲートウェイサービスでアカウントを作成し、Webhookを設定するために以下の詳細を取得します。

• 採用担当者
• 候補者名
• 商談の金額
• 面接情報
• 面接予定時刻

現在、Zohoは以下のSMSゲートウェイプロバイダーと提携しています。

• Twilio
• Clickatell
• Screen Magic
• Message Media

上記のベンダーからSMSクレジットとAPI詳細を購入できます。

ユーザー定義パラメーターを設定する際に、［面接］タブから以下の項目を選択します。

• SMSゲートウェイのドメイン名
• ユーザー名
• 認証トークン

Webhookで、以下の詳細を指定します。

［通知先のURL］：
http://<Domain Name>/smsgateway/post - POST方式

［ユーザー定義パラメーター（XMLまたはJSON）］
<?xml version='1.0'?>
<m:Library xmlns:m='http://www.screen-magic.com/' xmlns='http://www.defns.com/'>
<username>xxxx@xxxxx.com</username>
<senderid>SMS-Provider</senderid>
<accountid>XXXXXXX</accountid>
<authtoken>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</authtoken>
<message mobilenumber='${User.Mobile}'>こんにちは ${Interviews.Interviewer}、${Interviews.From}に${Interviews.Location}で候補者：${Interviews.Candidate Name}の面接が予定されました。</message>
</m:Library>

メモ
上記のXML文字列では、デモ用にScreen Magicゲートウェイを使用しています。

［ワークフローのルール］ページで以下の手順を実行します。

1. すべての新しい面接に対するワークフローを作成します。
   
   • 種類は［新しい面接］です。
   • ステージは［完了］です。
   • ［完了予定日］を選択します。
2. 上記のとおりWebhookを設定します。
3. ［保存して関連付け］をクリックします
4. ［保存］をクリックして、ワークフローのルールを保存します。

更新済みのすべての面接情報を含むテスト用の面接データを追加します。
携帯電話でSMS通知を確認します。SMSを受信していない場合は、Webhookの設定を修正し、テストを続けます。テストが成功したら、テスト用のエントリーを削除し、この連携をZoho Recruitユーザーに展開します。

エラーコードの参照

Webhookの実行に失敗した場合、Zoho Recruitで次のいずれかのエラーメッセージが表示されます。

HTTPステータスコード

• 400 Bad Request - 必須パラメーターが不足していることがよくあります。
• 401 Unauthorized - 有効な認証トークンが指定されていません。
• 402 リクエスト失敗 - パラメーターは有効ですが、リクエストに失敗しました。
• 404 見つかりません - リクエストされた項目が存在しません。
• 500、502、503、504 サーバーエラー - サードパーティーアプリケーションで問題が発生しました。
• エラーコード1 - APIサーバーに一時的に接続できません。Recruitから送信されたリクエストについて、APIサーバーのログとファイアウォール設定を確認してください。

カスタムエラー

内部処理の失敗 - Webhookの処理中にエラーが発生したため、Webhookが実行されなかった場合。
1日の上限に達しました - 会社がその日の上限に達した場合。