Webhookブロックにおける外部連携の設定
ボットの会話フローにおいて、Webhookを通じて外部アプリ／システムのデータを取得、更新する際に、外部アプリ／システムと連携する必要があります。このような場合に、Webhookブロックの外部連携が役立ちます。
外部連携を設定することで、対象の外部アプリ／システムとの連携を安全に行うことが可能です。以下では、外部連携の概要や設定方法について説明します。
外部連携とは
外部連携とは、外部アプリ／システムと安全に連携するための設定情報です。Zoho Desk、Zoho CRM、Google スプレッドシートなどの外部アプリ／システムとWebhookを通じてデータ通信を行う際に、認証情報を入力する手間を省くことが可能です。また、独自のAPIにも対応しています。独自のAPIについては、該当のヘルプを別途ご確認ください。
Webhookブロックを設定する際に、アクセストークンやAPIキーなどの機密情報をリクエスト内でコード化せずに、外部連携に関連付けることができます。外部アプリ／システムとの連携に必要な設定をより効率よく行うことが可能です。
外部連携の作成対象は、以下のとおりです。
- Zohoサービス（Zoho OAuthの使用）
- Slack、Googleなどの外部アプリ（標準の外部連携）
- Stripeなどの他の外部アプリ（独自の外部連携）
- 組織で使用する内部用のAPI、独自のAPI
外部連携が重要な理由
外部連携の使用を強くお勧めする理由は、以下のとおりです。なお、必須の場合もあります。
- トークン、シークレット、APIキーなどの機密情報を暗号化し、非表示にできる
- 他の会話フローやWebhookブロックにおいて、同一の外部連携を繰り返し使用できる（毎回認証設定を行う手間を省くことができる）
- APIトークンやスコープが変更された際に、変更内容を一元管理できる
- 複数のユーザーが共同してボットや会話フローを作成する際に、全員が同じ外部連携を使用できる（全員が機密情報にアクセスする手間を省くことができる）
外部連携を使用するタイミング
ボットを通じて、Webhookブロックによって行われる処理の例は以下のとおりです。
- Zoho Deskから問い合わせのデータを取得する
- Zoho CRMで新しい見込み客のデータを作成する
- 外部アプリ／システムから注文ステータスを取得する
これらの処理を行うには、ボットと外部アプリ／システム間でデータ通信を安全に行う必要があります。外部連携を使用することで、OAuthやAPIキーを通じてこれらのデータ通信を安全に行うことが可能です。
外部連携は、認証が必要なデータ通信を行う場合に特に重要です。外部連携が無効な場合、リクエストが却下される可能性があります。
認証の種類
認証
認証
外部連携を作成するにあたって、対象の外部アプリ／システムによって認証方法は異なります。
| サービスの種類 | 認証方法 | 使用例 |
| Zohoサービス | Zoho OAuth | Zoho Deskから問い合わせのデータを取得する |
| 外部アプリ／システムのAPI | OAuth 2.0 | SlackやGoogle スプレッドシートでデータを更新する |
| 独自のAPI | APIキー／Basic認証 | 内部データベースにアクセスする |
Zohoサービスの場合、認証方法としてZoho OAuthが標準で使用されます。
外部連携の作成方法
Webhookブロックを使用して、Zoho Deskから問い合わせの詳細を取得したいとします。この場合に外部連携を作成するには、以下の手順を実行します。
外部連携の設定
1.Webhookブロックの画面に移動します。
2.ボットの設計画面で、対象の処理を行う場所にWebhookブロックを追加します。
3.外部連携のセクションで［追加する］をクリックします。
4.Delugeのページに移動します。
5.［外部連携を作成する］をクリックします。
6.対象のサービスを選択します。Zohoサービスの場合、［Zoho OAuth］を選択します。
7.外部連携の名前を入力します。識別しやすい名前を入力してください。例：ZohoDesk_TicketReader
8.入力内容に基づいて、システムによってリンク名が自動で生成されます。
9.スコープを選択します。
10.ボットに対して許可する処理を設定します。たとえば、「ZohoDesk.tickets.READ」の場合、ボットに対して問い合わせの情報の表示を許可します。 「ZohoCRM.modules.ALL」の場合、Zoho CRMのすべてのタブへのアクセスを許可します。
11.完了後、［作成して連携する］をクリックします。
12.認証手続きを完了します。
13.表示されるポップアップ画面で、［連携する］をクリックします。
14.確認画面で［同意する］をクリックし、ボットに対してAPIを通じて処理を実行する権限を許可します。
15.外部連携の設定が完了します。
16.Webhookブロックの画面に戻ります。
17.外部連携のドロップダウンの隣の［更新する］をクリックし、新しい外部連携の一覧を表示します。
18.対象の外部連携を選択して、［保存する］をクリックします。
外部連携を使用して、安全に認証できるようになります。
使用例
使用例
チャットの利用者の入力内容に応じて、ボットを通じてZoho Deskから問い合わせの詳細を取得したいとします。この場合、Webhookにトークンを追加する代わりに、以下のURLを使用して問い合わせの詳細を取得することが可能です。
URL：
URLを設定し、必要に応じてクエリーパラメーター（例：ticketNumber = @input.ticketNumber）を追加し、外部連携（ZohoDesk_TicketReader）を選択できます。
Zohoサービスの外部連携では、OAuthトークンを使用してリクエストの認証が行われます。手動でトークンを入力、管理する必要はありません。
外部連携に関する詳細については、該当のヘルプをご参照ください。