Webhookブロックのクエリーパラメーター

クエリーパラメーターを使用することで、Webhookのリクエストを送信する際に問い合わせ番号、メールアドレス、ステータスなどの詳細を合わせて送信できます。クエリーパラメーターをもとに、外部アプリ／システムに対して対象となるデータを指示することが可能です。

以下では、Webhookブロックのクエリーパラメーターの概要や使用例について説明します。

クエリーパラメーターとは

クエリーパラメーターとは、APIのURLの末尾に追加されるキーと値の組み合わせを表します。クエリーパラメーターを指定することで、対象の外部アプリ／システムのサーバーに対して対象となるデータを指示できます。

クエリーパラメーターを指定したURLの例は、以下のとおりです。

この例の場合のキーと値は以下のとおりです。

以下のように、アンパサンド（&）を使用して複数のクエリーパラメーターを指定することも可能です。

この例では、問い合わせ番号が「12345」、ステータスが「未完了」、優先度が「高」の問い合わせが指定されています。

クエリーパラメーターの利点は、以下のとおりです。

ボットの会話フローのWebhookブロックの画面で、クエリーパラメーターを追加できます。こちらの画面で、キーと値の組み合わせを入力することが可能です。

クエリーパラメーターの例は、以下のとおりです。

1件のWebhookのリクエストに対して追加可能なクエリーパラメーターの上限は、20件です。

使用例

1.外部アプリ／システムから特定の問い合わせの詳細を取得する

APIのURL：https://api.example.com/tickets

クエリーパラメーター：

最終的なリクエストの値：

2.現在のステータスが「未完了」の問い合わせのみを取得する

APIのURL：https://api.example.com/tickets

クエリーパラメーター：

最終的なリクエストの値：

3.複数の詳細を取得する

Zoho Deskのなどのサービスの一部のAPIでは、基準となるリクエストに加えて［連絡先］や［商品］などの関連タブを含めることができます。

例：

このリクエストでは、問い合わせの情報に加えて、問い合わせに関連付けられている以下の情報を取得することが可能です。