Skip to main content
WEBHOOK
See Return webhooks for lifecycle semantics, status normalization, pull reconciliation, and a complete payload example.

Headers

X-Omni-Event-Id
string
required

Stable event id and recipient idempotency key.

X-Omni-Event-Type
string
required
X-Omni-Timestamp
string
required
X-Omni-Signature
string
required

Hex HMAC-SHA256 over timestamp.rawBody.

Body

application/json
schemaVersion
string
required
Allowed value: "2026-08-29"
id
string
required
type
string
required
Allowed value: "return.created"
occurredAt
string<date-time>
required
publishedAt
string<date-time>
required
organizationId
string
required
resourceVersion
integer
required
Required range: x >= 1
source
object
required
subject
object
required
data
object
required

Response

Event durably accepted.