Skip to main content

Embeds

Embeds are embedded content elements that appear directly within your existing application elements. They seamlessly integrate help content, tips, and documentation right where users need them.

Why it Matters

Embeds provide contextual assistance without disrupting the user experience. By placing help content directly within your application’s interface, you can:
  • Reduce Support Tickets: Answer common questions before users need to reach out
  • Improve Feature Adoption: Guide users through complex features in context
  • Enhance User Experience: Provide help without forcing users to leave their workflow
  • Increase Self-Service: Enable users to find answers independently

Creating Embeds

To create a new embed:
  1. Navigate to the Embeds section in your dashboard
  2. Click on “Create New Embed”
  3. Design your embedded content with rich text, images, and links
  4. Configure the target element where the embed will appear
  5. Set up targeting rules to show embeds to the right users
  6. Publish your embed

Best Practices

  • Keep Content Concise: Embeds should provide quick, digestible information
  • Match Your Design: Style embeds to blend naturally with your application
  • Use Progressive Disclosure: Hide embeds as users become more proficient
  • Target Appropriately: Show embeds to users who need them most
  • Include Clear CTAs: Provide next steps or links to detailed documentation
  • Test Placement: Ensure embeds don’t interfere with core functionality

Configuration

Display Settings

  • Position: Configure where the embed appears relative to the target element
  • Trigger: Set how embeds appear (on page load, hover, click, etc.)
  • Dismissibility: Allow users to close or hide embeds permanently
  • Styling: Customize colors, fonts, and sizes to match your brand

Targeting Options

  • User Segments: Show embeds to specific user groups
  • Page Rules: Display embeds on specific pages or URLs
  • Feature Flags: Control embed visibility based on feature access
  • Behavioral Triggers: Show embeds based on user actions or inactivity

Analytics

Track the effectiveness of your embeds with comprehensive analytics:
  • View Count: Number of times the embed was displayed
  • Engagement Rate: Percentage of users who interact with the embed
  • Click-through Rate: Percentage of users who click on embedded links or CTAs
  • Completion Time: Average time users spend viewing the embed
  • Dismissal Rate: How often users close or dismiss the embed

Use Cases

Onboarding Help

Provide contextual guidance for new users as they navigate your application for the first time.

Feature Announcements

Highlight new features or updates directly where they’re located in your interface.

Help Documentation

Embed helpful tips, documentation, or tutorials alongside complex features or forms.

Process Guidance

Guide users through multi-step processes with embedded instructions at each stage.