Webhook サブスクリプションについて

Webhook サブスクリプションでは、一元化された構成を通じてカテゴリのすべてのイベントを受信します。これらは、リアルタイムのイベント処理、分析パイプライン、およびすべてのイベントを個々のメッセージ要求に分散させるのではなく、1か所にまとめたい監視システムに最適です。

設定手順は、Webhookサブスクリプションの管理をご参照ください。

Webhook サブスクリプションとは [#what-are-webhook-subscriptions]

Webhook サブスクリプションは、特定のチャネルまたはサービスで発生するすべてのイベントの通知を自動的に配信します。アプリケーションにとって重要なイベント(配信ステータス、受信返信、クリック、開封、バウンス)を定義します。NTT CPaaS は、これらのイベントが発生するたびに Webhook URL に通知を送信します。

• リアルタイム: Events は発生時にプッシュされます (オンデマンドでプルされません)。
• チャネルまたはサービスレベルのスコープ: 個々のメッセージではなく、1つの特定のチャネル(SMS、電子メール、WhatsAppなど)またはサービス(登録、モバイルID、ブロックリストなど)をサブスクライブします。
• 自動配信: 一致するすべてのイベントは、発生したときに Webhook URL に送信されます。
• 一元化されたルーティング: サブスクリプションエンドポイントは、カテゴリの選択したイベントを受信します。
• イベントフィルタリング: 必要なイベントタイプ(配信、受信、クリックなど)を指定し、オプションのフィルターで範囲を絞り込みます。
• スケーラブルでステートレス: 各イベントは独立しています。セッション接続や永続接続は必要なく、システムは大量のイベントストリームを効率的に処理します。

Webhook サブスクリプションのしくみ [#how-webhook-subscriptions-work]

サブスクリプション-通知-プロファイル関係 [#subscription-notification-profile-relationship]

subscription は、通知をトリガーするイベントを定義します。notification profile は、これらの通知が配信される場所と方法 (Webhook URL、配信設定、認証) を指定します。結果の通知は、イベント発生時に送信される実際の HTTP POST 要求です。すべてのサブスクリプションは通知プロファイルを参照する必要があり、このプロファイルを空にすることはできません。これらのコンポーネントの関連付けと削除の依存関係の詳細については、「サブスクリプション階層と削除ルール」を参照してください。

各コンポーネント(通知プロファイル、認証設定、証明書)の詳細な内訳と使用時期については、「サブスクリプションコンポーネント」を参照してください。

サブスクリプション フィルターとスコープ [#subscription-filters-and-scope]

サブスクリプションには、通知をトリガーするイベントを絞り込むためのオプションのフィルターを含めることができます。フィルターを空のままにすると、サブスクリプションは選択したカテゴリとチャネルのすべてのイベントに適用されます。

もっと詳しく知る

アプリケーション、エンティティ、および通話構成フィルターを使用すると、サブスクリプションを特定の顧客またはマルチテナント プラットフォームの構成にスコープ設定できます。詳細な設定は、「CPaaS XのWebhookサブスクリプション」(/cpaas-x/イベント-subscriptions)を参照してください。リソースの種類については、「リソースと数値の概要」を参照してください。

サブスクリプションとメッセージごとの Webhook の選択 [#choosing-between-subscriptions-and-per-message-webhooks]

Webhook サブスクリプションは、次の場合に使用します。

チャネルのすべてのイベントを 1 か所で処理したり、リアルタイムのイベント パイプラインやダッシュボードを構築したり、運用のシンプルさ (一度構成してどこにでも適用したり)、マルチテナント システムで大量のイベント処理を処理したりする必要があります。

次の場合にメッセージごとの Webhook を使用する

メッセージごとに異なるエンドポイントが必要になるか、メッセージ レベルのルーティング ロジックが必要か、一部のメッセージのみに Webhook が必要です。

Webhook URL のオーバーライド動作 [#webhook-url-override-behavior]

Webhook URL は、notifyURL、trackingURL、webhookURLなどのフィールドを使用して、個々のメッセージ送信リクエストで直接定義できます。これにより、サブスクリプションを構成せずに、特定のメッセージのイベント通知をすばやく受信できます。

API リクエストで Webhook URL を指定すると、システムはそれらを スタンドアロン通知プロファイル と照合します。システムが一致するものを見つけると、構成された詳細設定、証明書、またはセキュリティ構成が適用されます。一致するスタンドアロン プロファイルが存在しない場合、システムは追加の設定なしで通知を URL に転送します。

メッセージレベルのWebhookを使用する場合:

• Webhook の動作を迅速に検証する高速テスト シナリオ
• 特定のメッセージに異なる通知ルーティングが必要なフォールバックケース
• サブスクリプション設定なしの 1 回限りの通知

**予測可能なルーティングを行うには、次の場合にメッセージ レベルの Webhook の代わりにサブスクリプションを使用します。

• 一元化されたイベント処理を必要とする本番システムの実行
• 既にサブスクリプションを使用している場合、メッセージ レベルの URL を追加すると、競合するルーティングが作成されます
• メッセージごとの URL の管理がエラーが発生しやすい大量のメッセージングの処理