Interface WebhookEnvelope

The delivery envelope every webhook body conforms to, before narrowing by type. Prefer consuming WebhookEvent (the discriminated union); this generic shape exists for logging/storage layers that don't care which event they hold.

interface WebhookEnvelope {
    id: string;
    type: string;
    createdAt: string;
    partnerId: string;
    data: unknown;
}

Index

Properties

id type createdAt partnerId data

Properties

id

id: string

Unique event id — STABLE ACROSS RETRIES. Deduplicate on it: seeing the same id twice means a redelivery, not a new event.

type

type: string

Event name, e.g. async_consult.assigned.

createdAt

createdAt: string

When the event occurred.

partnerId

partnerId: string

Your partner id (useful when one endpoint serves several keys).

data

data: unknown

Event-specific payload — see the WebhookEvent union.

Interface WebhookEnvelope

Index

Properties

Properties

id

type

createdAt

partnerId

data

Settings

On This Page