Interface: EventsResource

Defined in: packages/sdk/src/resources/events.ts:18

Product events. Tracking an event upserts the contact, enrols them into any sequence triggered by that event type, and can exit them from others.

Example

const result = await mailroom.events.track({
  type: "order.placed",
  email: "ada@example.com",
  data: { orderId: "ord_123", total: 4200 },
  exitSequences: ["abandoned-cart"],
});
// { contactId, enrolled, reArmed, exited }

Methods

track()

track(input: EventInput, opts?: CallOptions): Promise<EventResult>;

Defined in: packages/sdk/src/resources/events.ts:20

Record an event for a contact (by email or contactId) and fire triggers.

Parameters

Parameter	Type
input	EventInput
opts?	CallOptions

Returns

Promise<EventResult>