Interface OutboxDelivery

One event's delivery to one destination.

interface OutboxDelivery {
    id: string;
    runId: string;
    destinationRef: string;
    eventId: string;
    type: MeetingEventType;
    payload: string;
    attempts: number;
    firstAttemptAt?: number;
    nextAt: number;
    state: "pending" | "delivered" | "dead";
    purged: boolean;
    kind: "event" | "mail";
    expiresAt?: number;
}

Properties

id runId destinationRef eventId type payload attempts firstAttemptAt? nextAt state purged kind expiresAt?

Properties

id

id: string

The delivery's id.

runId

runId: string

The run the event belongs to.

destinationRef

destinationRef: string

The product's reference for where it goes (a webhook registration).

eventId

eventId: string

The event the delivery carries.

type

type: MeetingEventType

The event's type; bot:purged once a purge emptied the delivery.

payload

payload: string

The body to send; empty once a purge emptied the delivery, and empty once a mail delivery ended (delivered, dead, cancelled or expired), so a mail's body outlives no pending delivery.

attempts

attempts: number

The failed attempts so far.

Optional firstAttemptAt

firstAttemptAt?: number

When the first failed attempt was recorded; a delivery still failing a day later is given up.

nextAt

nextAt: number

When the next attempt is due.

state

state: "pending" | "delivered" | "dead"

pending until the destination takes it, or until it is given up as dead.

purged

purged: boolean

Set when a purge emptied the delivery.

kind

kind: "event" | "mail"

What the delivery is: a run event to a webhook registration (event, the default), or a mail the host renders and sends (mail).

Optional expiresAt

expiresAt?: number

A mail delivery's expiry: it is not due after it, and markFailed ends it dead at it. Absent on an event delivery.

Settings

Member Visibility

Theme

On This Page

idrunIddestinationRefeventIdtypepayloadattemptsfirstAttemptAtnextAtstatepurgedkindexpiresAt