Webhook との統合

必要なアクセス権

Atlas を Webhook と統合するには、プロジェクトへのOrganization Owner またはProject Owner アクセス権が必要です。

Webhook 統合を構成する

Webhook にアラートを送信するには、アラート通知を構成します。詳しくは、「 アラート設定の構成 」を参照してください。

リクエスト ヘッダー

Atlas には、 Webhookリクエストごとに次のHTTPヘッダーが含まれています。

リクエスト本文

リクエストボディには、 Atlas Administration APIアラートリソースと同じ形式を使用するJSONドキュメントが含まれています。ペイロードには、次のようなキー フィールドが含まれます。

• id:アラートの一意の識別子。

• eventTypeName:アラートをトリガーしたイベントのタイプ。

• created:アラートが作成されたときのタイムスタンプ。

• status:アラートの現在のステータス（例: OPEN、CLOSED）。

• humanReadable:アラートの人間が判読可能な説明 。このフィールドには、「Project: [プロジェクト名] Organization: [org名]」形式のプロジェクト名と組織名、および他のアラートの詳細が含まれます。

フィールドの完全なリストについては、 Atlas Administration API がすべてのプロジェクト アラートを取得する ドキュメントを参照してください。

{
  "id": "5d1b6f8e8c2e4e2d3c4a5b6c",
  "groupId": "5d1b6f8e8c2e4e2d3c4a5b6d",
  "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
  "status": "OPEN",
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-01-15T10:30:00Z",
  "lastNotified": "2024-01-15T10:30:00Z",
  "humanReadable": "Disk space used on data partition is 95.2%.
    Project: MyProject Organization: MyOrganization",
  "metricName": "DISK_PARTITION_SPACE_USED_DATA",
  "currentValue": {
    "number": 95.2,
    "units": "RAW"
  }
}

Webhook リクエストの認証

Webhook Secretフィールドには、Atlas がリクエスト検証用の X-MMS-Signature ヘッダーを生成するためにのみ使用するシークレットが保存されます。 Atlas は、認証ヘッダーまたはベアラー トークンとしてシークレットを直接送信しません。

Webhook エンドポイントに認証が必要な場合は、次のいずれかの方法を使用して個別に処理する必要があります。

• クエリ パラメータ: クエリ パラメータとして の認証情報を含めます。例:Webhook URLhttps://example.com/webhook?token=your-auth-token

• IPアクセス リスト: Atlas IPアドレスからのリクエストのみを受け入れるように Webhook エンドポイントを設定します。この構成により、Atlas のみがエンドポイントにリクエストを送信できるようになります。

• 逆プロキシまたはAPIゲートウェイ: Webhook エンドポイントにリクエストを転送する前に認証を処理するリバース プロキシまたはAPIゲートウェイを使用します。

制限

Webhook 統合を使用する場合は、次の制限を考慮してください。

ファイアウォール構成

ファイアウォールでIP アクセス リストを構成する必要がある場合は、Atlas IPアドレスからのアクセスを許可して、Atlas が Webhook エンドポイントと通信できるようにします。

Webhook 配信の問題のトラブルシューティング

Webhook がアラートを受信しない場合: