JavaScript API Reference

// Identify the user and their properties
pyne(
  "identify",
  userId, // Unique User ID (string or number)
  userProperties // Optional: User Properties (object)
);

// Example:
pyne("identify", currentUser.id, {
  name: currentUser.name,
  email: currentUser.email,
  created_at: currentUser.created_at, // ISO-8601 format
});

// Clear user session (on logout):
pyne("identify", null);

/**
 * Start a specific guide by its ID.
 * This bypasses targeting rules but requires the guide to be Published.
 * guideId (string): The ID of the guide to start.
 */
pyne("startTour", guideId);

/**
 * Forcefully terminate the currently active guide.
 */
pyne("terminateCurrentTour");

// Guide started
pyne("onTourStarted", ({ id }) => {
  console.log(`Guide started: ${id}`);
  // Example: Send analytics event
});

// Guide completed successfully by the user
pyne("onTourFinished", ({ id }) => {
  console.log(`User finished guide: ${id}`);
});

// Guide terminated by the system (e.g., error, API call)
pyne("onTourTerminated", ({ id }) => {
  console.log(`Guide terminated: ${id}`);
});

// Guide dismissed by the user (e.g., clicking close button)
pyne("onTourDismissed", ({ id }) => {
  console.log(`Guide dismissed by user: ${id}`);
});

// User clicked the minimize button on the avatar
pyne("onUserMinimizedAvatar", ({ id }) => {
  console.log(`User minimized avatar for guide: ${id}`);
});

// User clicked the minimized avatar to expand it
pyne("onUserExpandedAvatar", ({ id }) => {
  console.log(`User expanded avatar for guide: ${id}`);
});

// Guide execution suspended (e.g., waiting for element, page change)
pyne("onTourSuspended", ({ id }) => {
  console.log(`Guide suspended: ${id}`);
});

// Guide execution resumed after being suspended
pyne("onTourUnsuspended", ({ id }) => {
  console.log(`Guide unsuspended: ${id}`);
});