Webhookの設定

Webhookの設定

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

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

シナリオ

  • Zoho RecruitのWebフォームを利用してWebサイトから収集した候補者や連絡先に基づき、メールマーケティングソフトウェア(例:MailChimp)のメーリングリストに購読者を追加できます。
  • 面接官や候補者に対して、処理内容を通知するSMSリマインダーをトリガーできます。

理想的なユーザー

  • 管理ワークフロー権限を持つRecruitユーザー
  • REST APIのスキルを持つプログラマー
Info
利用可能状況

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

Webhookの項目一覧

項目名 説明 データの種類 最大値
名前 Webhookの名前を指定してください。 テキスト 英数字(50文字)
説明 Webhookの説明を追加してください。 テキスト 200文字
URL to 通知 サードパーティアプリケーションのREST API URLを指定してください。 URL 200文字
Method APIメソッドの種類(POSTまたは取得する)を選択してください。初期設定ではPOSTメソッドが選択されています。 ラジオボタン -
タブ
Zoho Recruit タブのいずれかを選択します。
対応タブ:
  • 候補者、連絡先、求人などのRecruit主要タブ
  • 処理およびタスク

メモ: 通話ログおよびメモタブにはWebhookを設定できません。

ピッキングリスト -
Append 項目 パラメーター

パラメーター名と対応するパラメーター値を指定します。これらはWebhook通知をサードパーティアプリケーションにトリガーする際に送信されるリクエストパラメーターです。

対応タブ:
 

  • Recruit主要タブ
  • ユーザー
  • 組織
String 3000文字
Append カスタム パラメーター Webhook用のRecruitパラメーター名と対応する値を指定します。これらもWebhookをトリガーする際に送信されるリクエストパラメーターです。名前と値は設定内容に従います。このキー/値ペアは主に認証トークンやセキュリティトークンなどの送信に使用されます。 String -
プレビューする URL 完了 Webhook URL をサードパーティアプリケーションに通知する際にプレビューします。 テキスト 閲覧のみ

Webhook の設定

Webhook の設定は、以下の3つのステップで行います。

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

Webhook を作成するには:

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

サポートされていないマージ項目値の認識

Webhook の値説明エディターで使用しているマージ項目値が、${Unsupported_Field} と表示される場合があります。これは、以下のような理由が考えられます。

カスタム項目の削除

挿入したマージ項目の値が削除されています。Webhook の値説明エディターに削除された項目のマージ項目値が残っている場合、その値は ${Unsupported_Field} と表示されます。

カスタム look-up 項目の削除

挿入したカスタム look-up 項目の値が削除されています。Webhook の値説明エディターに削除された look-up 項目のマージ項目値が残っている場合、その値は ${Unsupported_Field} と表示されます。

利用可能なマージ項目リストに表示されていない項目

選択済みタブの利用可能なマージ項目一覧の中で、使用中のマージ項目値が次の値と等しくない場合、${Unsupported_Field}として表示されます。
例えば、Job Openingsタブの値説明エディターでマージ項目値${Candidates。Candidate Id}を挿入した場合、サポートされていない項目として表示されます。

Webhookをワークフロールールに関連付ける方法:

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

Webhook連携をテストする方法:

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

Notes
重要メモ
  • 1つのワークフロールールにつき、最大6件(1件のインスタント操作と5件の時間ベース処理)のWebhookを関連付けできます。
  • Webhookを使用して、Zoho Recruitからサードパーティアプリケーションへ最大10件のRecruit項目データを転送できます。
  • Webhookを利用して他のアプリからZoho Recruitへデータを取得することはできません。
  • APIチケットは、サードパーティアプリケーションの制限に従い定期的に更新する必要があります。
  • サードパーティAPIの問題によりWebhook連携が停止した場合、メール通知は送信されません。
  • WebhookのPOSTメソッド利用時、ユーザー定義形式は最大10,000文字まで許可されています。
  • 処理に失敗した場合、Webhookが最初に通知を送信し、その後Zoho Recruitシステムが15分後に2回目の通知を送信します。それ以降、そのワークフロートリガーに対してWebhook通知は送信されません。
  • 1日の最大件数を超えた場合、残りのWebhook通知はサードパーティアプリケーションへ送信されず、管理者に失敗が通知されます。
  • 通知項目のURLでポート番号を指定する場合、サポートされているのは80または443のみですのでご注意ください。
  • Webhookパラメーター設定時に、必要な日付/日時形式およびタイムゾーンを選択するオプションがあります。
  • Webhookの制限:
  • プロフェッショナルエディション - 10,000通話/日 または 100通話/ユーザーライセンス(いずれか少ない方)。
  • エンタープライズエディション - 20,000通話/日 または 200通話/ユーザーライセンス(いずれか少ない方)。

法人シナリオ

大量採用が実施されており、すべての面接官にSMSで注意喚起を送信する必要があります。このプロセスはWebhookを利用することで簡素化できます。


目的

予定された面接について、面接官にSMSで通知すること。


前提条件

  • SMS 決済サービス サービスのアカウント
  • ワークフロー ルールへのアクセス権限


手順

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


手順 1: SMS 決済サービス サービスでアカウントを作成

SMS 決済サービス サービスでアカウントを作成し、Webhookの設定に必要な以下の情報を取得してください。

  • リクルーター
  • 候補者名
  • 案件金額
  • 面接詳細
  • 面接予定時刻

現在、Zohoは以下のSMS 決済サービス プロバイダーと提携しています。

  • Twilio
  • Clickatell
  • Screen Magic
  • メッセージ Media

上記の仕入先からSMSクレジットやAPI情報を購入できます。


手順 2: Zoho RecruitでWebhookを設定

ユーザー定義パラメーターを設定する際、Interviewsタブから以下の項目を選択してください。

  • SMS決済サービスのドメイン名
  • ユーザー名
  • 認証トークン

Webhookで、以下の詳細を指定してください。

通知先URL:
http://<ドメイン 名前>/smsgateway/post - POSTメソッド

ユーザー定義パラメーター(XMLまたはJSON)


<ユーザー名>xxxx@xxxxx。com
SMS-Provider
XXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
<メッセージ mobilenumber='${ユーザー。モバイル}'>${Interviews。Interviewer}様、${Interviews。差出人}より${Interviews。場所}で候補者:${Interviews。Candidate 名前}の面接が予定されています

Notesメモ
上記のXML文字列では、デモンストレーション目的でScreen Magic決済サービスを使用しています。


手順 3: ワークフロー ルールの設定

ワークフールールのページで、次の手順に従ってください。

  1. すべての新規インタビューに対してワークフローを作成します。
    • 種類は新規Interviewです。
    • ステージは完了済みです。
    • Closing日付を選択します。
  2. 上記の手順に従いWebhookを設定します。
  3. 保存および関連付けをクリックします。
  4. ワークフールールを保存します。


手順 4: Webhook連携のテスト

すべての更新済みInterview詳細を含むテスト用Interviewデータを追加します。
モバイル電話番号でSMS通知を確認してください。SMSを受信していない場合は、Webhookの設定を修正し、テストを続行してください。テストが成功した後、テストエントリーを削除し、この連携をRecruitユーザーに展開します。

エラーコードの参照

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

HTTPステータスコード

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

カスタムエラー

内部プロセス失敗 - Webhookの処理中にエラーが発生し、Webhookが実行されなかった場合に表示されます。
日次上限到達 - 会社がその日の最大利用上限に達した場合に表示されます。


    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts









                                  Resources

                                  Videos

                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                  eBooks

                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                  Webinars

                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                  CRM Tips

                                  Make the most of Zoho CRM with these useful tips.