Skip to content

PERS SDK - v2.3.26 / Exports / SuccessEvent

Interface: SuccessEvent

Success event - uses Domain (business domains only)

Used for successful operations like:

  • Login success
  • Campaign claimed
  • Redemption completed
  • Transaction created

Hierarchy

  • BaseEvent

    ↳ SuccessEvent

Table of contents

Properties

Properties

id

• id: string

Unique event ID

Inherited from

BaseEvent.id

Defined in

core/events/event-types.ts:164


timestamp

• timestamp: number

Unix timestamp (ms)

Inherited from

BaseEvent.timestamp

Defined in

core/events/event-types.ts:166


type

• type: KnownEventType

Specific event type within domain

Inherited from

BaseEvent.type

Defined in

core/events/event-types.ts:168


userMessage

• userMessage: string

User-friendly message - ALWAYS present, ready for display

Inherited from

BaseEvent.userMessage

Defined in

core/events/event-types.ts:170


action

• Optional action: string

Suggested action for user (optional)

Inherited from

BaseEvent.action

Defined in

core/events/event-types.ts:172


code

• Optional code: string

Error/event code from backend

Inherited from

BaseEvent.code

Defined in

core/events/event-types.ts:174


details

• Optional details: EventDetails

Additional details for logging/debugging

Inherited from

BaseEvent.details

Defined in

core/events/event-types.ts:176


level

• level: "success"

Defined in

core/events/event-types.ts:189


domain

• domain: Domain

Business domain only (user, transaction, campaign, etc.)

Defined in

core/events/event-types.ts:191