Webhookの管理
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
Webhookの概要
Webhookにより、自動HTTP通知を実行できます。通知は、組織内のユーザーが事前に定義された操作を実行したときに、業務要件に応じてサードパーティアプリケーションでトリガーされます。
Webhookのビジネス活用例
- Webhookは、サードパーティのSMSベンダーと連携し、カード作成者や担当者など、カードに関連付けられたユーザーにSMS通知を送信するために使用できます。
- 関連するカードが完了したときに注文の配送を通知するよう、組織の物流アプリケーションと連携することもできます。
Webhookの追加
- Qntrlにログインします。
に移動し、［Webhook］をメニューの［詳細設定］から選択します。
- ［新しいWebhook］ボタンをクリックします。
- 詳細を入力します。各項目の仕様については、以下の表を参照してください。
- ［保存］をクリックします。
Webhook設定の項目一覧
|
項目名
|
説明
|
データ型
|
制限
|
|
［種類］
|
「スタンドアロン」または「ボード」を選択します。スタンドアロンWebhookはすべてのボードで使用できます。
|
ドロップダウン |
-
|
| ［名前］ |
Webhook名を指定します。
|
テキスト
|
3～50文字
|
|
［通知先URL］
|
サードパーティまたはZohoアプリケーションのAPI URLを指定します。
|
URL
|
265文字
|
|
［メソッド］
|
APIメソッドの種類（POSTまたはGET）を選択します。デフォルトではPOSTメソッドが選択されます。
|
ラジオボタン
|
- |
|
［認証情報］
|
認証情報は、新しい接続の開始時に使用するすべてのデータベース認証情報を保存してアクセスできる、一元管理リポジトリーです。詳細はこちら
|
ドロップダウン
|
-
|
|
［Bridgeで実行］
|
このオプションを選択すると、Webhookの詳細がBridgeに送信され、対応するAPIがトリガーされます。このオプションは、内部APIを操作する際に役立ちます。
|
チェックボックス
|
-
|
|
［Bridge／クラスター］
|
ドロップダウンに表示されているBridgeまたは負荷分散用のクラスターを選択します
|
ドロップダウン
|
|
|
［標準形式（JSON、XMLなど）のパラメーター］
|
1. パラメーター名を入力し、説明として挿入する値を選択します。
2. これらのリクエストパラメーターは、サードパーティアプリケーションへのWebhook通知をトリガーするときに使用されます。
3. 最大6件のパラメーターを設定できます。各パラメーター名は最大25文字まで入力できます。
|
テキスト
|
パラメーター名 - 25文字
パラメーター値 - 5,000文字
|
|
［標準形式（名前=値）のパラメーター］
|
1. パラメーター名を入力し、対応するパラメーター値を選択します。
2. これらのリクエストパラメーターは、サードパーティアプリケーションへのWebhook通知をトリガーする際に重要です。
3. 最大6件のパラメーターを設定できます。各パラメーター名は最大25文字まで入力できます。
|
テキスト
|
パラメーター名 - 25文字
|
|
［カスタムパラメーターの追加］
|
1. Webhookのパラメーター名と対応する値を指定します。
2. 最大5件のパラメーターを設定できます。各パラメーター名は25文字まで入力できます。
3. このキー／値ペアは、主に認証トークン、APIキー、セキュリティトークンなどの送信に使用されます。
|
テキスト |
パラメーター名 - 25文字
パラメーター値 - 100文字
|
|
［カスタムヘッダー］
|
1. Webhookのヘッダー名と対応する値を指定します。
2. 最大3件のヘッダーを設定できます。各ヘッダー名は最大25文字まで入力できます。
3. Cookie、User-Agent、Referrerなどの送信に使用できます。
|
テキスト |
ヘッダー名 - 25文字
ヘッダー値 - 200文字
|
|
［URLのプレビュー］
|
サードパーティアプリケーションに送信される完全なWebhook URLをプレビューします。この項目は編集できません。
|
-
|
-
|
Webhookの制限
- 1件のビジネスルールに関連付けられるWebhookは最大3件です。
- 1件の遷移に関連付けられるWebhookは最大3件です。
- Webhookごとに、カード関連パラメーターは6件、カスタムパラメーターは5件まで使用できます。
Webhookとビジネスルールの関連付け
- クイックアクセス設定を使用して、ボード固有のビジネスルールに移動します。詳細はこちら。
- 新しいビジネスルールを作成するか、既存のルールを開きます。ビジネスルールの詳細はこちら。
- ルールの詳細を入力し、［条件と処理］に進みます。
- 次に、
アイコン（［即時アクション］または［予約アクション］の横）をクリックし、ドロップダウンから［Webhook］を選択します。
- 利用可能なWebhookの一覧から1つ以上のWebhookを選択するか、［Webhookを追加］をクリックします。
- Webhookを選択したら、［適用］をクリックします。
- ［保存］をクリックします。
Webhookとブループリントの関連付け
- ［ボード］に移動し、左パネルで任意のボードにカーソルを合わせ、
をクリックして［ボードの管理］を選択します。（または）
- ［ステップ2：ブループリントの設計］に移動します。
- 遷移をクリックし、右パネルの［実行後］セクションに移動します。
- 次に、［即時アクション］または［予約アクション］で、
- 利用可能なWebhookの一覧から1つ以上のWebhookを選択するか、［Webhookを追加］をクリックします。
- ［適用］をクリックします。
- ［ブループリントを保存］します。
Webhookの編集／削除
Webhookを編集するには、メニューの［詳細設定］にある［Webhook］を選択し、編集するWebhookをクリックします。Webhookを変更し、［保存］をクリックします。
Webhookを削除するには、Webhook名にカーソルを合わせ、
をクリックします。ポップアップで［削除］を選択し、操作を確定します。
削除すると、そのWebhookはどのブループリントにも関連付けられなくなります。