Webhooks との統合

必要なアクセス権

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

Webhook 統合の構成

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

リクエストヘッダー

Atlas は、各ウェブフック リクエストに次の HTTP ヘッダーを含めます。

リクエスト本文

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

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

• eventTypeName: アラートをトリガーするイベントの種類。

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

• status: アラートの現在の状態（例：OPEN、CLOSED）。

• humanReadable: アラートの人間が読み取り可能な説明。このフィールドには、プロジェクト名と組織名が "プロジェクト: [プロジェクト名] 組織: [組織名]" の形式で含まれ、その他のアラート詳細も含まれます。

フィールドの完全なリストについては、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 はシークレットを認証ヘッダーまたは Bearer token として直接送信しません。

ウェブフックエンドポイントで認証が必要な場合は、次のいずれかの方法を使用して独自に取り扱う必要があります。

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

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

• リバース プロキシまたは API ゲートウェイ: リバース プロキシまたは API ゲートウェイを使用して、リクエストをウェブフック エンドポイントとなる接続されたデバイスに転送する前に認証を取り扱います。

制限

ウェブフック統合を使用する場合は、次の制約事項を考慮してください。

ファイアウォール構成

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

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

ウェブフックがアラートを受信しない場合: