Logo
Logo
CTRLK

共有コンポーネント

CPaaS X の Webhook サブスクリプション


Webhook は、リアルタイムのイベント通知のための NTT CPaaS プラットフォーム機能であるサブスクリプションを通じて作成されます。CPaaS X では、サブスクリプションは「基準」フィルタリングを通じて スコープ付きイベント配信 をサポートします: 特定の applicationIdentityId、またはその両方のイベントをサブスクライブできます。これにより、他のエンティティからのデータを混在させることなく、各エンティティ独自のイベントについて常に情報を得ることができます。


マルチテナント イベント配信の課題 [#multi-tenant-event-delivery-challenge]

スコープ付きサブスクリプションのない従来のマルチテナント プラットフォームでは、すべてのイベントがフィルター処理なしで 1 つの Webhook にフローします。コードでは、各イベントを正しい顧客に帰属させる必要があり、イベントが誤ってルーティングされた場合に複雑さが増し、セキュリティ リスクが生じます。

Without scoped subscriptions

スコープ付きサブスクリプションなし

1 つの Webhook は、すべての顧客からすべてのイベントを受信します。システムは、顧客ごとにイベントを手動で解析、フィルター処理、およびルーティングする必要があります。これは複雑でエラーが発生しやすく、顧客間のデータ漏洩によるセキュリティリスクを生み出します。

With scoped subscriptions

スコープ付きサブスクリプションを使用する場合

各顧客は、イベントのみを受信する独自の Webhook を取得します。CPaaS X は、「基準」を使用してプラットフォームレベルでフィルタリングします。コードで手動の解析、ルーティング、またはフィルター処理は必要ありません。



スコープ付きサブスクリプションのしくみ [#how-scoped-subscriptions-work]

CPaaS X でサブスクリプションを作成する場合は、applicationIdentityId、ユーザー、またはリソースでイベントのスコープを設定するフィルターを定義します。サブスクリプションは、すべてのフィルター条件がイベントに一致する場合にのみトリガーされます。サブスクリプションは、Web インターフェイス (開発者ツール > サブスクリプション管理) または サブスクリプション APIを使用して管理できます。

json
1{
2 "subscriptionId": "customer-a-sms",
3 "events": ["DELIVERY", "INBOUND_MESSAGE"],
4 "criteria": [
5 {
6 "applicationId": "production",
7 "entityId": "customer-a"
8 }
9 ],
10 "profile": {
11 "profileId": "NOTIF-32395",
12 "webhook": {
13 "notifyUrl": "https://customer-a.yourplatform.com/webhooks/sms"
14 }
15 }
16}

customer-a Webhook は customer-a イベントのみを自動的に受信するため、コードから手動でフィルタリングするロジックが不要になります。



スコープ付きイベント配信が重要な理由 [#why-scoped-event-delivery-matters]

スコープ付きサブスクリプションには、マルチテナント プラットフォームに次の 3 つの重要な利点があります。

Data isolation

データの分離

プラットフォーム レベルで適用されます。顧客 A の Webhook は、顧客 B のイベントを受信しません。監査証跡は、コンプライアンスのためにエンティティごとに自然に分離されます。

Simplified integration

統合の簡素化

各 Webhook は、割り当てられたエンティティのイベントのみを受信します。すべてのイベントを受信し、それらを解析して、どの顧客に属しているかを判断する必要はありません。

Direct customer integration

顧客との直接統合

各顧客に独自のエンティティ スコープの Webhook エンドポイントを提供します。彼らは自分のイベントに関するリアルタイムの更新を受け取り、統合を独自に構築できます。



サブスクリプションの種類 [#subscription-types]

Application-level subscriptions

アプリケーションレベルのサブスクリプション

アプリケーション内のすべてのエンティティからすべてのイベントを受信します。applicationIdのみでスコープが設定されます(entityIdなし)。

最適な用途: 管理者および運用チームによるプラットフォームの監視、使用状況の追跡、コンプライアンス監査。

Entity-level subscriptions

エンティティ レベルのサブスクリプション

特定のエンティティのイベントのみを受信します。applicationIdentityId の両方でスコープが設定されます。

最適な用途: 顧客向けの更新と顧客ごとのイベント処理。特定のエンティティにサービスを提供する各顧客またはバックエンド システムには、独自の Webhook が割り当てられます。



サポートされているチャネルとイベントの種類 [#supported-channels-and-events]

サブスクリプションは、SMS、MMS、Email、WhatsApp、RCS、Viber、Voiceなど、20以上のチャネル、製品、サービスをサポートしています。チャネル別のイベントの完全なリストは、 利用可能なWebhookイベントを参照してください。



エンティティ/アプリケーションコンテキストを含むイベントコンテンツ [#event-content]

CPaaS X が Webhook イベントを送信すると、エンティティとアプリケーションコンテキストが含まれます。applicationIdentityIdの両方が配信レポートとコールバックイベントに表示され、アプリケーションとエンティティごとにトラフィックとイベントを追跡できます。

json
1{
2 "eventId": "evt-12345",
3 "timestamp": "2026-02-16T10:30:00Z",
4 "eventType": "message.delivered",
5 "entityId": "customer-a",
6 "applicationId": "production",
7 "data": {
8 "messageId": "msg-67890",
9 "recipient": "+1-555-0123",
10 "status": "delivered"
11 }
12}
手記

イベントタイプとペイロードスキーマの完全なリストについては、Webhookサブスクリプションのドキュメントを参照してください。

もっと詳しく知る
  • 実装とイベントの種類: 「Webhook サブスクリプション」を参照してください。
  • アプリケーションとエンティティのコンテキスト: アプリケーションとエンティティを参照してください。


関連ページ

アプリケーションとエンティティ
コアコンセプトとデータの分離。

送信戦略
リソースの関連付けとインテリジェントなルーティング。

指標とレポート
顧客ごとの使用状況の追跡と分析。