Skip to main content
WEBHOOK

Body

application/json

Envelope shared by every webhook event. The data object is typed per event; its shape is determined by type.

id
string<uuid>
required

UUID of the underlying Guardian event. Stable across delivery retries — use for deduplication.

type
enum<string>
required

Event type. Determines the shape of data.

Available options:
deploymentRolloutDetected,
deploymentVerificationScheduled,
deploymentVerificationStarted,
deploymentVerificationCompleted,
anomalyDetected,
investigationCreated,
investigationCompleted,
issueCreated,
agentActionRequested
timestamp
string<date-time>
required

RFC3339 time the event was emitted.

title
string
required

Human-readable plain-text title.

message
string
required

Human-readable plain-text message.

data
object

Typed event payload. The shape is determined by type (same order as the type enum).

Response

2XX

Return any 2xx status to acknowledge receipt.