Userorbit Checklists offer various item types to guide users through tasks and onboarding flows. Each type provides different functionality, configuration options, and completion detection methods to suit diverse use cases.
Checklist Item Types
Tour Link
What it does: Clicking this item initiates a specified product tour, guiding the user through a series of interactive steps within the application.
Configuration:
- In the checklist builder, select "Tour Link" as the item type.
- Choose the desired product tour from a dropdown list of available tours.
Completion Detection: The checklist item is marked as complete automatically once the linked product tour has been fully finished by the user.
URL Link
What it does: This item, when clicked, navigates the user to an external or internal URL. It's useful for linking to help documentation, external resources, or specific pages within your application.
Configuration:
- In the checklist builder, select "URL Link" as the item type.
- Enter the target URL in the provided input field.
- Optionally, specify if the URL should open in a new tab.
Completion Detection: The checklist item is marked as complete immediately upon the user clicking the link.
Custom Action/Event
What it does: This advanced item type allows completion to be triggered by a specific JavaScript event firing within your application. This is ideal for tracking custom user interactions that are not simple clicks or tour completions.
Configuration:
- In the checklist builder, select "Custom Action/Event" as the item type.
- Define the specific JavaScript event that Userorbit should listen for (e.g., event name, properties).
- This often involves instrumenting your application to emit custom events that Userorbit can track.
Completion Detection: The checklist item is marked as complete when the specified custom JavaScript event is detected as fired by the Userorbit SDK.
Manual Checkbox
What it does: A simple, user-driven item where the user explicitly marks the task as complete by clicking a checkbox. This is suitable for tasks that cannot be automatically tracked or require user affirmation.
Configuration:
- In the checklist builder, select "Manual Checkbox" as the item type.
- Provide the text description for the manual task.
Completion Detection: The checklist item is marked as complete only when the user manually clicks the checkbox next to the item in the checklist.
Comparison Table: Checklist Item Types
| Item Type | Functionality | Configuration in Builder | Completion Detection |
|---|---|---|---|
| Tour Link | Initiates a product tour. | Select existing tour from dropdown. | Tour completion. |
| URL Link | Navigates to a specified URL. | Enter target URL. | On click. |
| Custom Action/Event | Completes on a specific JS event. | Define JS event name/properties. | Specific JS event fires. |
| Manual Checkbox | User clicks checkbox. | Provide task description. | User clicks checkbox. |
Notes
- Ensure that product tours are properly configured and published before linking them to checklist items.
- For Custom Action/Event items, verify that the custom events are correctly implemented and being tracked by the Userorbit SDK.
- The checklist builder interface provides clear prompts and dropdowns for configuring each item type.