Skip to content

Webhook payload

The versioned event envelope, its stable fields, timestamp format, and unknown-field policy.

Core

Envelope

Every event uses the same outer shape. The data object varies by event type.

incident.opened (fixture identifiers)
{
  "id": "evt_01JEXAMPLE",
  "type": "incident.opened",
  "created_at": "2026-07-15T22:15:00Z",
  "schema_version": "2026-07-21",
  "organization": {
    "id": "org_public_reference",
    "name": "Example Org"
  },
  "data": {
    "incident": {
      "id": "inc_public_reference",
      "title": "Checkout API is unavailable",
      "severity": "major",
      "status": "down",
      "opened_at": "2026-07-15T22:14:00Z"
    }
  }
}

Fields

FieldTypeNotes
idstringUnique event id. Use as your idempotency key.
typestringOne of the documented event types.
created_atstringISO 8601 UTC timestamp.
schema_versionstringDate-based version of the envelope.
organizationobjectPublic organization reference.
dataobjectEvent-specific payload.

Compatibility

  • Timestamps are ISO 8601 in UTC.
  • New fields may be added without a version bump. Ignore unknown fields.
  • A field is only removed with a schema version change and advance notice.

Was this page helpful?