Event-based Targeting Reference

Event-based targeting in Userorbit allows you to trigger in-app experiences such as Product Tours, Checklists, and Surveys based on specific user actions within your application. These actions, or "events," are tracked via the Userorbit SDK and provide a dynamic way to engage with users at critical moments in their journey.

Properties

event_name — string — The unique identifier for the user action being tracked (e.g., 'Product Viewed', 'Signup Complete', 'Button Clicked').
properties — object — An optional JSON object containing key-value pairs that provide additional context or metadata about the event. These properties can be used for more granular targeting and analysis.

Examples

Tracking Custom Events via SDK

To track a custom event, use the userorbit.track() method available in the Userorbit SDK. This method accepts the event name and an optional object of properties.

Simple Event Tracking

Track a basic event without additional properties:

userorbit.track('Signup Complete');

Event Tracking with Properties

Track an event and include relevant data as properties. These properties can then be used to refine targeting rules.

userorbit.track('Product Viewed', {
  product_id: 'PROD-001',
  product_name: 'Userorbit Pro Plan',
  category: 'Subscription',
  price: 99.99
});

Using Events in Targeting Rules

Events tracked via the SDK can be leveraged within Userorbit's targeting rules to specify when a feature should be displayed. Rules can be configured based on the presence of an event, the number of times an event has occurred, or specific values of event properties.

User has performed 'First Login' event exactly 1 time: Triggers a feature only on the user's very first login.
User has performed 'Feature X Used' event at least 3 times: Activates a feature (e.g., a survey) only after a user has interacted with a specific feature multiple times.
User has performed 'Product Viewed' event with property category equal to 'Electronics': Targets users who have viewed products specifically within the 'Electronics' category.

Notes

Granular Targeting: Event properties are crucial for creating highly specific targeting rules, allowing you to tailor experiences to user segments based on their in-app behavior.
Common Use Cases:
- Display a **Product Tour** to new users immediately after their 'First Login' event.
- Trigger an **Onboarding Checklist** for users who have completed a 'Signup Complete' event.
- Show a **Survey** to gather feedback after a user has performed a 'Feature X Used' event a certain number of times (e.g., 3 times) to ensure they have sufficient experience.
- Present an **Announcement** about a new feature to users who have interacted with a related part of the product, identified by specific event properties.
SDK Integration: Ensure the Userorbit SDK is correctly integrated into your application to accurately capture and transmit user events.

Help Center