お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の
英語版を参照してください。
Zoho Recruitを使用してイベントが発生するたびに、即時のWeb通知を送信することで、Webhooksはサードパーティのアプリケーションとの通信を可能にします。 Webhooksを使用すると、HTTP URLを構成し、ワークフロールルールに関連付けることで、通知プロセス全体を自動化できます。
シナリオ
- Zoho RecruitのWebフォームを使用して、ウェブサイトから収集した候補者またはコンタクトを使用して、メールマーケティングソフトウェア(例:MailChimp)にサブスクライバーを追加できます。
- インタビュアーまたは候補者にSMSリマインダーをトリガーして、イベントに関する通知を送信できます。
理想的なユーザー
- マネージワークフロー権限を持つユーザーを募集する
- REST APIスキルを持つプログラマー
利用可能性
必要なプロファイル権限:ワークフローの管理権限を持つユーザーがこの機能にアクセスできます。
ウェブフック内のフィールドのリスト
フィールド名 | 説明 | データ型 | 最大制限 |
名前 | ウェブフックの名前を指定してください。 | テキスト | 英数字(50) |
説明 | Webhookに説明を追加してください。 | テキスト | 200文字 |
通知するURL | サードパーティーアプリケーションのREST APIのURLを指定してください。 | URL | 200文字 |
方法 | APIの方法の種類を選択してください - POSTまたはGET。デフォルトでは、システムはPOST方法を選択します。 | ラジオボタン | - |
モジュール | Zoho Recruitモジュールのいずれかを選択してください。 サポートモジュール: - 候補者、連絡先、求人などのRecruitプライマリモジュール
- イベントとタスク
注:コールログとノートモジュールに対してWebhookを設定することはできません。 | ピックリスト | - |
パラメータの追加 | パラメータ名と対応するパラメータ値を指定してください。これは、Webhook通知を第三者アプリケーションに送信する際に送信されるリクエストパラメータです。 サポートされているモジュール: | 文字列 | 3000文字 |
カスタムパラメータの追加 | ウェブフックに対して、募集パラメータ名とそれに対応する値を指定します。これはウェブフックをトリガーする際に送信されるリクエストパラメータでもあります。名前と値は設定されたものです。このキー/値ペアは、主に認証トークン、セキュリティトークンなどを送信するために使用されます。 | String | - |
プレビューURL | サードパーティアプリケーションに通知される完全なWebhook URLをプレビューします。 | テキスト | 読み取り専用 |
Webhooks の設定
ウェブフックの設定には以下の3つのステップが含まれます:
- ウェブフックを作成します。
- ワークフロールールにウェブフックを関連付けます。
- ウェブフックの統合をテストします。
ウェブフックを作成する方法:
- 「設定」→「自動化」→「アクション」→「Webhook」に移動します。
- 「Webhook」ページで、「Webhookの設定」をクリックします。
- 「新規Webhook」ページで、必要なパラメータをすべて指定します。
- 「保存」をクリックします。
不支持的合并字段值的辨认
時々、マージフィールドの値がWebhookのValue Descriptionエディターで使用されていると、${Unsupported_Field}と表示されることがあります。以下は、これが起こる理由のいくつかです。
カスタムフィールドの削除
削除された値を挿入したマージフィールドがあります。WebhookのValue Descriptionエディターが削除されたフィールドのマージフィールド値を引き続き含んでいる場合、その値は${Unsupported_Field}として表示されます。
カスタムルックアップフィールドの削除
削除された値が挿入されているカスタムルックアップフィールドがあります。 Webhookの値説明エディターに削除されたルックアップフィールドのマージフィールド値が残っている場合、その値は${Unsupported_Field}として表示されます。
利用可能なマージフィールドのリストに記載されていないフィールド
もし、選択したモジュールのリストにないフィールドのマージフィールドの値を使用した場合、${Unsupported_Field}と表示されます。
例えば、Value Description エディターにJob Openings モジュールに${Candidates.Candidate Id}のマージフィールドの値を挿入した場合、サポートされていないフィールドとして表示されます。
ワークフロールルールにWebhookを関連付けるには:
- 「設定」>「自動化」>「ワークフロールール」に移動します。
- ワークフロールールのページで、「新規作成」をクリックします。
- 新規作成ページで、ワークフロールールのパラメータを指定します。
- ワークフローアクションの下で、「Webhooks」を選択します。
- Webhookを呼び出すポップアップで、必要なWebhookを選択し、「関連付け」をクリックします。
- 「保存」をクリックします。
ウェブフックの統合をテストするには:
- Zoho Recruit に従ってワークフロールルールの基準に従ってテストデータを追加してください。
- アプリケーションでは、Zoho RecruitからのWebhook通知で受信したデータを確認してください。
- エラーまたはデータの不一致がある場合は、Zoho RecruitのWebhook設定を変更してください。
- アプリケーションからZoho Recruitから必要なデータを取得するまで、このテストを続けてください。
重要なお知らせ
- 1つのワークフロールルールに、最大6つ(インスタントアクション1つとタイムベースアクション5つ)のWebhookを関連付けることができます。
- Zoho Recruitからサードパーティアプリケーションへの最大10項目のデータ転送がWebhookを使用して可能です。
- Webhooks を使用して、他のアプリから Zoho Recruit へのデータ取得ができません。
- サードパーティアプリケーションの制限に従って、APIチケットを定期的に更新する必要があります。
- サードパーティーAPIの問題によりWebhook統合が機能しなくなった場合、メール通知を受け取ることはありません。
- Webhooks では、POST メソッドを使用する場合、ユーザー定義形式について最大 10000 文字を許可しています。
- プロセスに失敗した場合、Webhookが最初に通知を送信し、Zoho Recruitシステムが15分後に2番目の通知を送信します。 その後、その特定のワークフロートリガーに関しては、Webhookの通知は送信されません。
- 1日あたりの最大数を超えると、システムは残りのWebhook通知を第三者アプリケーションに送信しなくなり、管理者に失敗を通知します。
- 「URL to Notifyフィールドにおいて、ポート番号を指定したい場合、80番または443番のみがサポートされていることをご留意ください。」
- Zoho Recruitは、Webhookパラム構成中に必要な日付/日時形式とタイムゾーンを選択するオプションを提供しています。
- Webhooks の制限:
- プロフェッショナル・エディション - 1日あたり10000回またはユーザー1人あたり100回(少ない方)のライセンス。
- エンタープライズ・エディション - 毎日20000回または1ユーザーあたり500回(どちらか少ない方)の呼び出し。
ビジネスシナリオ
大規模な採用が行われており、すべての面接者にSMSアラートが送信される予定です。Webhookを使用することで、このプロセスを簡素化できます。
目的
スケジュールされた面接に関して、インタビュアーにSMSを通じて通知します。
事前準備
- SMS ゲートウェイサービスのアカウント
- ワークフロールールへのアクセス許可
手順
- SMS ゲートウェイサービスにアカウントを作成する
- Zoho RecruitにWebhookを設定する
- ワークフロールールを設定する
- Webhook統合のテストを行う
ステップ1:SMSゲートウェイサービスにアカウントを作成する
SMS ゲートウェイサービスでアカウントを作成し、Webhookを構成するためにこれらの詳細を取得します。
- 担当採用担当者
- 候補者氏名
- 機会金額
- 面接の詳細
- 面接予定時間
現在、Zohoは以下のSMSゲートウェイプロバイダーと提携しています:
- Twilio(ツイリオ)
- Clickatell(クリックテル)
- Screen Magic(スクリーンマジック)
- Message Media(メッセージメディア)
上記のベンダーからSMSクレジットとAPIの詳細を購入することができます。
ステップ2:Zoho RecruitにWebhookを設定する
インタビューモジュールから以下のフィールドを選択して、ユーザー定義パラメーターを設定してください:
- SMS ゲートウェイのドメイン名
- ユーザー名
- 認証トークン
ウェブフックで、次の詳細を指定してください:
通知するURL:
http://<ドメイン名>/smsgateway/post - POST メソッド
変更可能なパラメータ(XMLまたはJSON)xxxx@xxxxx.comSMS-ProviderXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXHi ${Interviews.Interviewer}, An Interview has been scheduled for on ${Interviews.From} at ${Interviews.Location} for candidate: ${Interviews.Candidate Name} 注意
上記の XML 文字列では、デモンストレーション用に Screen Magic ゲートウェイを使用しています。
ステップ3: ワークフロールールの設定
ワークフロールルールページで以下の手順を実行してください:
-
新しいインタビューのためのワークフローを作成します。
- タイプは「新規インタビュー」です。
- ステージは「終了」です。
- 終了日を選択します。
- 上記のようにWebhookを設定します。
- 保存して関連付けをクリックします。
- 保存ワークフロールール。
ステップ4:Webhook統合のテスト
テストインタビュー記録を追加して、更新されたインタビューの詳細をすべて入力してください。
携帯電話でSMSアラートを確認してください。SMSを受信していない場合は、Webhookの構成を変更してテストを続行してください。テストが成功したら、テストエントリを削除して、この統合をRecruitユーザーにロールアウトしてください。
エラーコードを参照する
Webhookの実行が失敗した場合、Zoho Recruitに以下のエラーメッセージのいずれかが表示されます。
HTTPステータスコード
- 400 Bad Request - 必要なパラメーターが欠落していることがよくあります。
- 401 Unauthorized - 有効なAuth Tokenが提供されていません。
- 402 Request Failed - パラメーターは有効ですが、要求が失敗しました。
- 404 Not Found - 要求された項目は存在しません。
- 500, 502, 503, 504 サーバーエラー - サードパーティーアプリケーションで何かが間違っています。
- エラーコード1 - APIサーバーへの接続が一時的にできません。Recruitからの送信要求のために、APIサーバーログ、ファイアウォール設定を確認する必要があります。
カスタムエラー
内部プロセスの失敗 - Webhook の処理中にエラーが発生したため、Webhook が実行されなかった場合。
日限度に達した - 会社が当日の最大限度に達したとき。