Webhookブロックを使用すると、自動ガイドボットの処理をZoho Deskや他のサービス(他のZohoサービスや外部サービス)の処理と連携できます。たとえば、連携している処理やサービスから取得したデータを自動ガイドボットの内容に反映したり、自動ガイドボットを通じて取得した顧客情報を他のサービスに登録したりすることが可能です。Webhookブロックによるデータ連携は、APIを通じて行われます。そのため、APIを通じてアクセスできるデータや、APIを利用して実行される処理であれば、Webhookブロックを通じて自動ガイドボットと連携させることができます。
Webhookブロックを使用するメリット
Webhookブロックを使用することで、外部サービスと連携してさまざまな処理を実行できます。Webhookブロックを使用する主なメリットは、以下のとおりです。
1.外部サービスとのリアルタイムでのデータ連携
2.外部サービスのデータに応じたメッセージの作成
オンラインストアの場合、注文ステータスや配送状況に関する情報をリアルタイムで取得し、チャットの利用者に対して表示できます。
3.複雑な自動化処理の設定
たとえば、メールの送信、問い合わせの作成、ユーザーのデータの取得などの操作をZoho Deskで自動的に実施するように設定できます。
4.機能の拡張
5.業務フローの自動化
6.迅速な対応
7.エラーや例外に対する処理
8.条件に基づいた処理の実行
たとえば、ユーザーによって購入手続きが行われた際に、通知を送信するように処理を設定できます。
利用例
電化製品を扱うオンラインストアがあるとします。この組織では、Webサイトのチャットを通じて顧客からの問い合わせに対応しています。ある顧客から、購入したタブレット端末の画面が破損しているため交換に関する問い合わせを受け付けました。この場合、Webhookブロックを使用することで、APIを実行し、データベースから顧客情報(例:名前、メールアドレス)を取得することができます。また、Webhookブロックを通じてZoho Deskと連携し、顧客の情報をもとにZoho Deskで問い合わせや連絡先を作成することも可能です。このように、Webhookブロックを使用することで、他のサービスと円滑に連携することが可能です。
Webhookブロックの作成
1.[設定]→[自己解決]→[自動ガイドボット]の順に移動します。
2.Webhookブロックを追加するフローの編集画面を開きます。
3.フロー編集画面で、(ブロックの追加)アイコンをクリックします。画面右側にブロックの追加画面が表示されます。 4.ブロックの追加画面で[処理ブロック]を選択し、[Webhook]を選択します。
5.表示されたWebhookブロックの作成画面で、以下の詳細を入力します。
a) ブロック名:ブロック名を入力します。なお、日本語は使用できませんのでご注意ください。例:Fetch Contact
すでに登録されているブロック名を入力すると、以下の画像のようにエラーが表示されます。
b) メソッド:APIの実行のためのメソッドの種類を一覧から選択します。
選択できるメソッドは、以下のとおりです。
- GET:既存のデータを取得します。
- PATCH:既存のデータの一部を更新します。
- POST:データを作成するか、既存のデータを更新します。
- PUT:データの一部を修正します。
- DELETE:既存のデータを削除します。
このAPIの実行後、WebhookのURLは処理に関する情報の受信を停止します。
c) URLに外部アプリのREST APIのURLを入力します。
1.[パラメーター(入力値)]の項目をクリックして、データの並び替えやフィルターの条件を入力します。例:@email
2.APIの実行を選択した場合、ヘッダーとして組織IDまたはポータルIDを入力します。組織ID/ポータルIDは、ヘッダーの値として指定する必要があります。
APIにより、この組織ID/ポータルIDを通じて処理が実行されます。
3.本文の欄で、JSONを選択して項目を追加するか、[ファイルのアップロード]を選択してファイルをアップロードします。
- JSONを選択した場合は、次の設定を行います。
a. 必須の変数: APIで必須に設定されている変数を追加します。これらの項目は、Zohoサービスまたは外部サービスのポータルで有効になっており、自動ガイドボットの要素と関連付けられている必要があります。変数の値を入力するには、変数と「@」記号を入力し、選択リストの中から変数の値を選択します。
b. カスタム項目: 本文の欄で、連携する外部サービスやZohoサービスのポータルで有効なカスタム項目を入力します。
- [ファイルのアップロード]を選択した場合は、次の設定を行います。
c. アップロードするファイルのキーと値を入力します。
4.[保存する]をクリックします。
5.Zoho Deskのポータルとの連携を設定するには、次のいずれかを選択します。
- サービスの選択:既存のサービスと連携します
- 独自のサービス:新しい連携を設定します
リクエスト本文(ボディ)のパラメーターに関する留意事項
- GETメソッドでは、リクエスト本文(ボディ)を通じてデータを送信することはできません。
本文のセクションで宣言した値には、顧客から取得するデータが設定されるようにします。そうでない場合は、本文の欄で変数の初期値を設定する必要があります。変数に@記号を設定した場合、情報はチャットを通じて取得されるため、@記号の変数には、自動ガイドボットで顧客が入力した値が設定されます。
- オレンジ色で表示されている他のすべての値は固定値であるため、値として顧客の入力内容を適用することはできません。これらの項目または変数については、設定済みの値が適用されます。
サービスの選択
既存のサービスとの連携を設定するには、以下の手順を実施します。
1.上記のWebhookブロックの作成の手順1から手順9までを実施します。
2.[外部連携]の項目で、[追加する]をクリックします。
外部連携の管理ページ(DRE)が新しいタブで表示されます。
3.サービスの選択欄で、すでに連携が有効になっている外部サービス、またはZohoサービスを選択します。
4.連携と連携用リンクの名前を入力します。
表示される画面で、サービスの適用範囲を選択する必要があります。
5.[Create and Connect](作成して連携する)をクリックします。
6.表示される確認画面で、組織/ポータルとワークフローとの連携を承認します。
外部連携の概要ページが以下のように表示されます。
7.Webhookブロックの作成画面の[外部連携]の項目で[更新する]をクリックし、外部連携の情報を反映させます。
8.サービスの選択欄で、対象の外部連携名を選択します。
9.[応答(レスポンス)]の欄で[ステータスコード]をクリックし、以下の操作を実施します。
- APIドキュメントの取得元となるステータスコードを入力します。
ステータスコードに関する変数が自動で生成されます。 - [フローの変数]、[出力値]、[種類]、[データの種類]の各項目を入力します。
- アイコンをクリックすると、フローの変数をさらに追加できます。
- [保存する]をクリックします。
別のステータス番号を追加してフローの変数をさらに追加する場合は、[新しい出力値を追加する]をクリックします。
10.[処理の時間切れ(リクエストのタイムアウト)]の項目で時間を設定します。初期値は「8秒」です。
11.[保存する]をクリックします。
12.フローの編集画面で、[保存する]をクリックします。
13.[プレビュー]をクリックし、フローが正常に動作するかを確認します。
Webhookブロックの右上に表示されている[コピーする]または[削除する]をクリックすると、Webhookブロックをコピー/削除できます。 独自のサービス
新しい外部連携を作成するには、以下の手順を実施します。
1.上記のWebhookブロックの作成の手順1から手順9までを実施します。
2.[外部連携]の項目で、[追加する]をクリックします。
外部連携の管理ページ(DRE)が新しいタブで表示されます。
3.[Custom Service](独自のサービス)タブを選択します。
4.独自のサービスの設定ページで、以下の詳細を入力します。
Service Name(サービス名)
Service Link Name(サービスリンク名)
Authentication Type(認証の種類):連携のための認証方法を選択します
Param Type(パラメーターの種類)
Connection Name(外部連携名)
Connection Link Name(連携リンク名)
5.[Create and Connect](作成して連携する)をクリックします。
6.表示される確認画面で、組織/ポータルとワークフローとの連携を承認します。
外部連携の概要ページが表示されます。
7.Webhookブロックの作成画面の[外部連携]の項目で[更新する]をクリックし、外部連携の情報を反映させます。
8.サービスの選択欄で、対象の外部連携名を選択します。
9.[応答(レスポンス)]の欄で[ステータスコード]をクリックし、以下の操作を実施します。
- APIドキュメントの取得元となるステータスコードを入力します。
ステータスコードに関する変数が自動で生成されます。 - [フローの変数]、[出力値]、[種類]、[データの種類]の各項目を入力します。
- アイコンをクリックすると、フローの変数をさらに追加できます。
- [保存する]をクリックします。
- 別のステータス番号を追加してフローの変数をさらに追加する場合は、[新しい出力値を追加する]をクリックします。
10.[処理の時間切れ(リクエストのタイムアウト)]の項目で時間を設定します。初期値は「8秒」です。
11.[保存する]をクリックします。
12.フローの編集画面で、[保存する]をクリックします。
13.[プレビュー]をクリックし、フローが正常に動作するかを確認します。
Webhookブロックの編集
必要に応じてWebhookブロックを編集できます。自動ガイドボットのフローが公開中、または下書きであっても編集可能です。編集するには、以下の手順を実施します。
1.フローの一覧画面で対象のフローをクリックし、フローの編集画面を開きます(フローにカーソルを合わせると表示される鉛筆アイコンをクリックすることでも編集画面が表示されます)。
2.編集するWebhookブロックをクリックします。
3.操作メニューで[ブロックを編集する]を選択します。
4.ブロックの編集画面が表示されます。必要に応じてブロックを編集し、[保存する]をクリックします。
5.フローの編集画面で、[保存する]をクリックします。
6.フローを公開します。