Top
Creating a Beacon
  • 16 Jan 2023
  • 2 Minutes To Read
  • Dark
    Light
  • PDF

Creating a Beacon

  • Dark
    Light
  • PDF

A Beacon enables you to quickly catch your end user's attention to a particular part of your application.

Creating a Beacon is a 2-step process.

Use the Editor extension to perform the first step to capture the part of the screen where you want the Beacon to appear. Then, on the Whatfix Dashboard, you need to define when and where the Beacon needs to appear.

Step 1: Create the Beacon

Step 2: Configure the Segment for the Beacon

Step 1: Create the Beacon

  1. On the Whatfix Editor, click Beacons
  2. Enter a name for the Beacon Collection. 
Note
  • A Beacon Collection is a group of Beacons belonging to the same page within an application.
  • The Beacon Collection name is solely for your (creator's) reference and is not visible to the end-user.
  • Visibility Rules are defined for a Beacon Collection. So even if you have only one Beacon on a page, it needs to be part of a collection.
  1. To create a new Beacon, click the +Beacon button.Editor_plus_beacon
  2. Select an element on the application where the Beacon must appear.

  3. Enter the name of the Beacon.
    RB_DB_beacon_name
    Note
    The Beacon name is solely for your (creator's) reference and not visible to the end user.
  4. Enter a description for the Beacon action.
    RB_DB_beacon_description
Note

The Beacon Description is visible to the end user when they hover their cursor over the Beacon.

  1. Under the Beacon Style section, choose the style and color of the Beacon.Beacon_choose beacon style


    Info
    • You can select the Custom style to change the text of the Beacon.clm_beacon_custom text(1)
    • If you don't see the customization options, contact [email protected].
    Note
    • By default, the Beacon color is red.
    • To change the Beacon color, click the Customise this Beacon checkbox, and then select a color. You can choose from the existing color palette or pass the hex code of the desired color.beacon_customize beacon
  2. Set the position and visibility for the Beacon.
  3. Click Add Beacon.
    RB_EDT_Beacon_savebeacon
    Note
    Multiple Beacons can be included on a single page. To include more Beacons, click the +Beacon button and repeat 4 to 8 for each Beacon.
  4. Click Maximize.
    RB_DB_Beacon_maximize
  5. Click Save.
    Your title goes here
    Once you have created the Beacon collection, a segment is automatically created on your Whatfix Dashboard.

Step 2: Configure the Segment for the Beacon

your title goes here

If your account is Smart Context enabled, then the Visibility Rules are configured automatically, and all you need to do is activate the segment as shown in step 9. For more information, see Smart Context.

Configuring segments enables you to control who sees your content, and when and where your Beacon is displayed. 

Use the following steps to configure the Beacon segment,

  1. Navigate to the Whatfix Dashboard. 
  2. In the left panel, click Widgets.
    RB_DB_Click widgets(1)
  3. Click the Beacon tile.
    RB_DB_Beacon_clickbeacon
  4. Navigate to the auto-created segment. The segment name is the Beacon collection name. Click the Edit icon.

    Note
    The Beacon Collection that is attached is the newly published content.
  1. Expand the Set Visibility Rules section and configure your Visibility Rules that determine how the Beacon collection is displayed to the end-user.
    RB_DB_beacon_setvisibilityrules
    Note
    For more information on the different conditions that can be used in Visibility Rules, see Visibility and Display Rule Conditions.
  1. Click the When tab and then select the number of times you want to show the Beacon.
    RB_DB_Whentab(1)
  2. To attach a Flow, video, or link to the Beacon, expand Attach Content section, click the Attach Content button, and then select the content you want to display to your users. 
Note

The attached content starts based on the Disappearance of Beacon setting you configure while creating it.

  1. Click Save.
  2. On the Segment page, activate the segment.
    RB_EDT_Activatebeacon
Note
  • The Beacon stops displaying once the end user clicks it. To show the Beacon again, you can refresh the Beacon segment or re-create it.
  • If Beacons are to be used for multiple pages, separate collections need to be created for each individual page.
  • Subsequent changes to the Beacon collection do not update the corresponding segment.

Was this article helpful?


Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.