Customize Content Suggestions in Beacon

Display specific help content to your customers depending on the page they visit. Choose from the Docs articles connected to your Beacon, or from the external links of your choice.

In this article

Set Suggestions for a Specific URL

To add a new URL, click the Everywhere panel, then click the Add a URL link from the menu. In the modal that pops up, enter the URL where you want specific articles to show in Beacon. You can add up to 200 URLs per Beacon. 

From there, you can enter up to 5 suggestions for that URL. Click on each Top Article list item to choose a help article from the connected Docs site or collection.

Edit the Content on a URL

You can edit the articles that appear on a specific URL at any time. Click the URL dropdown menu and hit the Edit button to show the current settings for that URL and make changes.

Disable Top Articles Suggestions

Set custom suggestions under Everywhere to override the Top Articles. The Show Top Articles button will be available to toggle off. 

Link to External Pages

Choose the Add a web link option to insert a link to an external page outside of the Docs site. The URL is the address of the link, the Text will be the linked text that shows in your Beacon. Both fields are required. 

Supported URL Structures

We support just about any URL structure, including relative paths. The URL must start with a forward slash (/),  http: or https: and can include wildcards (*). You can put the wildcard (*) anywhere in the URL. A relative path will use the domain of the page that is calling the Beacon. Here are a few examples of supported structures: 

  • https://*/folder/directory
  • https://*.mydomain.com/folder
  • https://*.*/folder/directory
  • https://domain.com/folder/*/settings
  • /folder/directory 
  • /folder/*/settings

Common Questions

Can I suggest articles based on criteria other than URL?
You can use JavaScript to programatically set suggestions based on the criteria of your choice - the sky is the limit with further custom coding. Follow the formatting in the Beacon('suggest') method in the Beacon Developer Docs.

I want my external link to use the actual webpage's title. Why do I have to enter text?
At this time, Beacon is not able to connect to an external link to retrieve the title from the page. The text you enter in the suggestion will be displayed in the Beacon, no matter what the actual website title. 

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still stuck? How can we help? How can we help?