JourneyService API

Journey Service is the main entry point for extending your application's capabilities with Journeys.

To access JourneyService functions; get its instance from DataSapien object: DataSapien.getJourneyService().

Functions (JavaScript)

Public functions
Promise<void>	JourneyService.syncJourneys() Synchronizes journey list with the Orchestrator. Parameters None
Promise <Journey[]>	JourneyService.getJourneys(tags, statuses) Fetches journeys from local storage with optional filters. Parameters tags : [String] - Optional journey tags. statuses : [String] - Optional journey statuses ("sent", "completed", "notStarted").
Promise <Journey | null>	JourneyService.getJourney(name) Returns a journey by name. Parameters name : String - Journey name.
Promise<any>	JourneyService.runJourney(name, data) Executes journey UI and returns the output JSON. Parameters name : String - Journey name. data : [String: Any] - Input payload.
Promise <JourneyExecutionRecord[]>	JourneyService.getJourneyExecutionRecords(name) Returns all execution records for a journey. Parameters name : String - Journey name.
Promise <JourneyExecutionRecord | null>	JourneyService.getJourneyExecutionRecord(name) Returns the latest execution record for a journey. Parameters name : String - Journey name.
Promise<string>	JourneyService.getJourneyStatus(name) Returns the current journey status. Parameters name : String - Journey name.

Classes (JavaScript)

Journey (JavaScript)

{
  id: string;
  name: string;
  flow: JourneyFlow;
  metadata: JourneyMetadata;
  tags?: string[] | null;
  zpdRequest?: JourneyZPDRequest | null;
  createdAt: number;
  updatedAt?: number | null;
  publishedAt?: number | null;
}

JourneyMetadata (JavaScript)

{
  title: string;
  description?: string | null;
  imageUrl?: string | null;
}

JourneyFlow (JavaScript)

{
  xml: string;
  data?: JourneyFlowData[] | null;
}

JourneyFlowData (JavaScript)

{
  type: string;
  name: string;
  source: string;
  origin?: string | null;
}

JourneyZPDRequest (JavaScript)

{
  requested?: JourneyFlowData[] | null;
}

JourneyFlowDataType (JavaScript)

"MEDATA" | "INPUT" | "CALCULATED" | "ANSWER"

JourneyStatus (JavaScript)

"NOT_STARTED" | "COMPLETED" | "SENT"

JourneyStatusFilter (JavaScript)

JourneyStatus[]

JourneyContext (JavaScript)

{
  values: { [key: string]: any };
}

JourneyExecutionRecord (JavaScript)

{
  id: string;
  status: string;
  journeyContext?: JourneyContext | null;
  date: number;
}

JourneyZPD (JavaScript)

{
  data: SharedData[];
}

SharedData (JavaScript)

{
  type: string;
  name: string;
  source: string;
  origin?: string | null;
  value: string;
}