メインコンテンツまでスキップ

Webhook

備考

プレビュー

Lakewatch は プライベートプレビュー段階です。アクセスをリクエストするには、Databricksアカウントチームにお問い合わせください。

Lakewatch アラートをWebhookにエクスポートします。アラートが作成されると、Lakewatch はそれを設定した HTTPS Endpoint に JSON ペイロードとして送信し、独自の自動化でアラートに対応できるようにします。送信先全体でのエクスポートの動作については、アラート通知先を参照してください。

Webhookへのエクスポートは一方向で、LakewatchからEndpointへのエクスポートのみです。

Webhookペイロード​

LakewatchがアラートをWebhookにエクスポートすると、JSONペイロードがPOSTされます。Lakewatchは、アラートが作成されるとlakewatch.alert.createdイベントを送信します。また、すでにエクスポートされたアラートに後で変更があった場合にもlakewatch.alert.updatedイベントを送信しますが、これは宛先でアップデートの配信が有効になっている場合にのみ行われます。クローズは、端末のalert_state(RESOLVEDまたはDUPLICATE)を伝達する更新であるため、別のクローズイベントはありません。アップデートの配信を有効にする設定については、「 設定を構成する」を参照してください。

配信はイベントごとに最大で 1 回行われ、再試行は行われません。配信に失敗しても、アラートはLakewatchに作成されます。

注記

キーはsnake_caseです。Enumフィールドは、数値ではなく、 "SECURITY_ALERT" のような文字列の名前として送信されます。設定されていないオプション フィールドは、 null として送信されるのではなく JSON から省略されるため、欠落している数値フィールドは 0 ではなく存在しません。

ヘッダー​

各リクエストには次のヘッダーが含まれています。

  • Content-Type: application/json
  • User-Agent: Databricks-Webhooks/1.0
  • X-Webhook-Event-Typeイベントタイプ
  • X-Delivery-Attempt-Id: 配信試行ID
  • X-Webhook-Timestamp: エポックミリ秒単位の配信時間

エンベロープフィールド​

フィールド

説明

event_type

lakewatch.alert.created または lakewatch.alert.updated

delivery_attempt_id

配信試行ごとに一意。重複の削除に使用します。

delivery_time_millis

配信が送信されたエポック(ミリ秒単位)。アラートが作成された時刻ではありません。

data

アラートオブジェクト。「アラートフィールド」を参照してください。

フィールド

説明

event_type

lakewatch.alert.created または lakewatch.alert.updated

delivery_attempt_id

配信試行ごとに一意。重複の削除に使用します。

delivery_time_millis

配信が送信されたエポック(ミリ秒単位)。アラートが作成された時刻ではありません。

data

アラートオブジェクト。「アラートフィールド」を参照してください。

アラートフィールド​

dataオブジェクトにはアラートが含まれています。以下は、ほとんどの利用者が操作するフィールドです:

フィールド

説明

alert_id

グローバルに一意なアラートID(uuidv7)。このフィールドで、同じアラートのcreatedイベントとupdatedイベントを関連付けます。

seq_id

人が読みやすい表示 ID(例:sec-42)。表示専用であり、キーではありません。

alert_type

SECURITY_ALERT.

alert_state

OPEN、IN_PROGRESS、MITIGATED、RESOLVED、DUPLICATEのいずれか。

severity

Informational、Low、Medium、High、Criticalのいずれか。情報レベルのアラートはエクスポートされません。

title

短いアラートタイトル。

classification

FALSE_POSITIVE、BENIGN_POSITIVE、またはTRUE_POSITIVEのいずれか。アナリストがアラートをトリアージするまで設定されず、作成時ではなくupdatedイベントに表示されます。

assignee

アラートが割り当てられているプリンシパル。割り当てられるまで設定されないため、updatedイベントに表示されます。

alert_url

Lakewatch UI内のアラートへのディープリンク。設定解除も可能です。

created_at_millis

アラートが作成されたエポックミリ秒。

created_by

アラートを作成したプリンシパル: id、principal_type (REGULAR_USER、SERVICE_PRINCIPAL、またはSYSTEM_USERのいずれか)、email、およびdisplay_name。

フィールド

説明

alert_id

グローバルに一意なアラートID(uuidv7)。このフィールドで、同じアラートのcreatedイベントとupdatedイベントを関連付けます。

seq_id

人が読みやすい表示 ID(例:sec-42)。表示専用であり、キーではありません。

alert_type

SECURITY_ALERT.

alert_state

OPEN、IN_PROGRESS、MITIGATED、RESOLVED、DUPLICATEのいずれか。

severity

Informational、Low、Medium、High、Criticalのいずれか。情報レベルのアラートはエクスポートされません。

title

短いアラートタイトル。

classification

FALSE_POSITIVE、BENIGN_POSITIVE、またはTRUE_POSITIVEのいずれか。アナリストがアラートをトリアージするまで設定されず、作成時ではなくupdatedイベントに表示されます。

assignee

アラートが割り当てられているプリンシパル。割り当てられるまで設定されないため、updatedイベントに表示されます。

alert_url

Lakewatch UI内のアラートへのディープリンク。設定解除も可能です。

created_at_millis

アラートが作成されたエポックミリ秒。

created_by

アラートを作成したプリンシパル: id、principal_type (REGULAR_USER、SERVICE_PRINCIPAL、またはSYSTEM_USERのいずれか)、email、およびdisplay_name。

ペイロードには、name(アラートのリソース名)、description、rule_version、first_event_summary、first_event_at_millis、last_event_at_millis、total_event_count、triggering_signal(代表的なセキュリティイベント)を含めることもできます。

以下は、lakewatch.alert.createdペイロードの例です。

JSON
{
"delivery_attempt_id": "fde7344f-2786-4516-a30b-dbd920207c9c",
"event_type": "lakewatch.alert.created",
"delivery_time_millis": 1790205121081,
"data": {
"name": "rules/4b54c235-39e7-476e-aac8-260f123f4533/alerts/81030035-3fa7-4ac2-859f-4215ebeca2d9",
"alert_id": "81030035-3fa7-4ac2-859f-4215ebeca2d9",
"seq_id": "sec-512",
"alert_type": "SECURITY_ALERT",
"alert_state": "OPEN",
"severity": "Medium",
"title": "Suspicious login activity",
"alert_url": "https://<workspace-host>/lakewatch/explore/alerts/sec-512",
"first_event_summary": "Multiple failed logins from a new location",
"total_event_count": 1,
"created_at_millis": 1790204960768,
"created_by": {
"id": "147014482147330",
"principal_type": "REGULAR_USER",
"email": "analyst@example.com",
"display_name": "Alex Analyst"
}
}
}

updated イベントは同じ形状で、 event_type が lakewatch.alert.updated に設定され、現在の alert_state があり、 classification や assignee などの作成後のフィールドが入力されています。

前提条件​

アラート JSON ペイロードを処理でき、POST 要求を受け入れる HTTPS Endpoint。

Webhookエクスポートの構成​

アラート の設定セクションで、アラートのWebhook送信先を設定します。

  1. Lakewatchサイドバーで、 設定 に移動し、 アラート を開きます。
  2. アラート の下にある Export 設定を見つけます。
  3. エクスポート先を Webhook に設定します。
  4. ワークスペース の場合、送信先がPrivateLink Endpointやリージョン制限されたサービスなど、特定のワークスペースのネットワークの背後にある場合を除き、現在のワークスペースを保持してください。このワークスペースのネットワークがエクスポートを提供します。
  5. [Webhook URL] に、アラートが送信されるEndpointを入力します。
  6. 変更を保存します。

アラート設定の全リファレンスについては、「 設定の構成」を参照してください。

トラブルシューティング​

  • ペイロードがEndpointに到達しません :URLが間違っているか、EndpointがPOST要求を受け入れていません。URL を確認し、Endpoint に到達可能であり、 JSON POST を受け入れることを確認します。