AppNavi Guide API

AppNavi Client-Side JavaScript API

AppNavi provides a client-side JavaScript API that allows you to control and customize various AppNavi avatar functions.

The API is organized into separate APIs for different AppNavi features, including Application, Route, Pins, and Analytics. These APIs provide methods and events that can be used to control AppNavi behavior and customize its functionality.

Custom code is written in JavaScript.

API Access

If AppNavi is integrated into a page using the an-loader, you can execute the Custom Code API in two ways:

Through the browser console.
Through the Custom Code hooks available in the AppNavi Portal.

If AppNavi is integrated using the Chrome Extension, the API can only be accessed through the Custom Code hooks in the AppNavi Portal. It cannot be accessed through the browser console.

The API methods are available through the following object:

window.appnaviApi

Available APIs

Application APIs

The Application API provides methods and events for managing AppNavi application and avatar behavior.

It includes functionality such as loading the avatar, setting target audience conditions, retrieving the current application and subscription information, and managing other application-level behavior.

The Application API also includes the Announcement, News, and Info APIs:

News and Announcement APIs: Provide methods for controlling the display, hiding, and reading behavior of news and announcements across applications.
Info API: Provides methods for displaying information as tooltips for specified applications.

Route APIs

The Route API provides methods and events for controlling routes and managing the route flow.

AppNavi supports Custom Code at both the route and step levels. Custom code can be executed in the context of the corresponding route and can also respond to route events such as route start, route stop, and step navigation.

The Route API also includes automation functionality. The Automation API provides methods for controlling the automation flow within a route.

Pins APIs

The Pins API provides methods and events for managing the AppNavi Pins feature.

It includes functionality for showing and hiding pins, retrieving pins, responding to pin hover events, and managing other pin-related behavior.

Analytics APIs

The Analytics API provides methods for managing analytics-related data and user behavior information.

Set User Role: Allows you to define a user role for analytics. The role can be used to associate interactions with a specific role and organize analytics data accordingly.
UBM Configuration: Allows you to configure User Behavior Monitoring (UBM) settings, including whether UBM events should be captured.

The Analytics API also provides APIs for sending UBM and custom events, which can be used to capture application-specific user interactions.