parseWebhookEvent

Parse a webhook delivery body into the typed WebhookEvent union. Every payload Seismic delivers is validated against the same Zod schemas the rest of the SDK uses, so the resource embedded in the event (kyc_profile, kyb_profile, account, order, deposit) comes back fully typed. Narrowing on event_type narrows data with it.

Always verify the delivery's signature before parsing. Deliveries carry the signature headers svix-id, svix-timestamp, and svix-signature; verify them against your endpoint's signing secret. See Delivery semantics.

Alongside event_type and data, every parsed event carries created_at — when the event was recorded, stable across retries and replays of that event. It is typed optional because events recorded before the field existed have none to replay. See Envelope.

const event = parseWebhookEvent(body);
 
switch (event.event_type) {
  case "account.deposit_received": {
    // `event.data` is narrowed: `deposit` is present and typed.
    const { deposit, account_id } = event.data;
    console.log(`deposit ${deposit.id}: ${deposit.amount} → account ${account_id}`);
    break;
  }
  case "order.status_changed": {
    console.log(`order ${event.data.order_id} → ${event.data.status}`);
    break;
  }
  case "customer.kyc.status_changed":
  case "customer.kyb.status_changed": {
    console.log(`customer ${event.data.customer_id} → ${event.data.status}`);
    break;
  }
}

Arguments: payload: unknown. A raw JSON string or an already-parsed object.

Returns: WebhookEvent.

Throws: ZodError when the payload doesn't match any known event shape (or SyntaxError for a malformed JSON string). For a non-throwing variant, parse yourself with WebhookEventSchema.safeParse(JSON.parse(body)).

WebhookEvent

A discriminated union over the twelve event types in the catalog, keyed on event_type:

The embedded resource fields are optional for the backfill caveat reason: freshly-emitted events always carry them. Replays of older deliveries may not.

Per-event schemas are also exported individually (AccountDepositReceivedEventSchema, OrderStatusChangedEventSchema, …) along with WebhookEventSchema for the whole union.

Payload reference: Customer events, Account events, Order events.