RelayEvent

A recorded delivery-ledger event travelling the relay.

This is the tunnel's wire payload: the CLI hands the exact detail body to the developer's local receiver, re-signed locally (the relay never mints a platform-signed outbound scheme). It carries the delivery ledger's status and metadata, never the recipient — the same posture the delivery ledger holds.

channelstring | nullnullable

Channel the attempt used, when known (sms, email, …).

delivery_idstringrequired

Stable idempotency id for this ledger event, chosen by the delivery pipeline. A redelivered POST with the same id is a no-op.

detailobject

The ledger row's detail object, carried verbatim.

event_idstringrequired

The trigger event's id (evt_…), the ledger's event_id.

occurred_atstring<date-time>required

When the ledger row was recorded.

providerstring | nullnullable

Provider that produced the outcome, when known.

statusstringrequired

Delivery status: DELIVERED, FAILED or SUPPRESSED.

workspace_idstring<uuid>required

Workspace the ledger row belongs to. The tunnel is scoped to it.

RelayEvent

{
  "channel": "string",
  "delivery_id": "string",
  "detail": {},
  "event_id": "string",
  "occurred_at": "2024-07-29T15:51:28.071Z",
  "provider": "string",
  "status": "string",
  "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}