event overview

Added in v2.0.0

---

Table of contents

• capabilities
  • EventEnv (interface)
• methods
  • event
• model
  • Event (interface)
  • EventOptions (interface)

---

capabilities

EventEnv (interface)

Defines capabilities and services required by the event method in order to work.

Signature

export interface EventEnv
  extends HttpSvc,
    CookieSvc,
    LocationSvc,
    DocumentSvc {}

Added in v2.0.0

methods

event

SDK’s event method: sends provided event to Customer Hub’s API.

Signature

export declare const event: (E: EventEnv) => Event;

Added in v2.0.0

model

Event (interface)

Defines the event method signature.

Signature

export interface Event {
  (options: EventOptions): Effect;
}

Added in v2.0.0

EventOptions (interface)

Defines the event method options.

Signature

export interface EventOptions {
  type: string;
  properties?: EventProperties;
}

Added in v2.0.0