Webhook を使用すると、プラットフォームで特定のイベントが発生したときに、外部アプリケーションがリアルタイムで通知を受け取ることができます。
Webhook を使用するには、Webhook を有効にしてトークンを生成する必要があります。単一の Webhook URL に 2 つの別々のシークレットを使用すると、セキュリティが強化されます。なんらかの理由で 1 つのシークレットが漏洩した場合やローテーションが必要になった場合は、Webhook サービスを中断したり、データ セキュリティを損なうことなく、シークレットを更新してローテーションできます。
Webhook をオンにする
Webhook を有効にする手順は次のとおりです。
CCAI Platform ポータルで、[設定 > デベロッパー設定] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。
[Webhook] ペインに移動し、[Webhook] 切り替えボタンをオンにします。
[URL] に、Webhook URL を入力します。この URL は、リアルタイム通知を受信するエンドポイントです。この Webhook が HTTP リクエストを受信できることを確認してください。
[生成] をクリックします。これにより、受信 Webhook ペイロードの認証と検証に使用されるメインのセキュリティ トークンであるプライマリ シークレットが生成されます。これは、Webhook 通信を保護するための主な手段として機能します。
トークンをコピーして安全な場所に保存します。
セカンダリ シークレットを生成します。セカンダリ シークレットは、バックアップまたはフェイルオーバー セキュリティ トークンとして機能します。これは、Webhook 通知の信頼性と可用性を高めるための追加のセキュリティ対策として提供されます。なんらかの理由でプライマリ シークレットが漏洩した場合や、その使用に問題がある場合は、セカンダリ シークレットが引き継ぎ、通信を継続できます。
トークンをコピーして安全な場所に保存します。
[保存] をクリックします。
シークレットをローテーションする
セキュリティのベスト プラクティスとして、Webhook シークレットを定期的にローテーションします。このプロセスでは、プライマリ Webhook とセカンダリ Webhook の両方に対して新しいシークレット キーを生成し、アプリケーションで更新して、通知をシームレスに受信し続けます。
Webhook の初期設定後、新しいプライマリ シークレットを直接生成することはできませんが、新しいセカンダリ シークレットを生成してシークレットをローテーションし、変更することはできます。
シークレットをローテーションする手順は次のとおりです。
CCAI Platform ポータルで、[設定 > デベロッパー設定] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。
[シークレットをローテーション] をクリックします。
[保存] をクリックします。
新しいシークレットを生成する
2 つの新しいシークレット キーを取得するようにシークレットをローテーションする手順は次のとおりです。
CCAI Platform ポータルで、[設定 > デベロッパー設定] をクリックします。[設定] メニューが表示されない場合は、 [メニュー] をクリックします。
[生成] をクリックして、新しいセカンダリ シークレットを生成します。
[シークレットをローテーション] をクリックして、新しいセカンダリ シークレットをプライマリ シークレットにします。
[生成] をクリックして、古いプライマリ シークレットを置き換える 2 つ目の新しいセカンダリ シークレットを生成します。
[保存] をクリックします。