The blacklist in Chat+ lets you exclude specific pages of your website, so the Chat+ widget is not loaded or displayed there. You set up the blacklist via Settings > Widget in the Blacklisted urls section, using full URLs or regular expressions (RegEx). The blacklist only works with the new component widget.
A blacklist is a list of URLs or URL patterns on which the Chat+ widget must not appear. Use the blacklist, for example, to hide the widget on a checkout page, in an admin environment or on other pages where a chat is not wanted.
This article covers the following topics:
- What requirements apply to the blacklist?
- How do the whitelist and the blacklist work together?
- Setting up the blacklist
- Examples of URLs and RegEx patterns
What requirements apply to the blacklist?
New component widget required
The blacklist only works with the new Chat+ component widget. You can recognize this widget by the script https://cloudstatic.obi4wan.com/chatplus/obi-launcher.bundle.js in your website code. The blacklist has no effect on the legacy widget (ngbots).
Also keep the following requirements in mind:
- The blacklist only applies to the widget on your live website. In the internal preview in Chat+, the widget always remains visible, so you can keep testing it.
- Changes to the blacklist only take effect after you have saved them with Save and republished the widget with Publish.
How do the whitelist and the blacklist work together?
A whitelist determines on which pages the Chat+ widget may appear. A blacklist determines on which pages the widget must not appear. The blacklist always takes precedence.
- No whitelist and no blacklist set up: the widget appears on all pages of your website.
- Only a blacklist set up: the widget appears on all pages, except on the pages that match the blacklist.
- A URL matches both the whitelist and the blacklist: the blacklist wins and the widget is not displayed.
Setting up the blacklist
Follow these steps to exclude pages from the Chat+ widget:
- In the menu, go to Settings > Widget.
- Scroll to the Blacklisted urls section.
- In the URL or RegEx pattern field, enter a full URL or a regular expression.
- Click + or press Enter to add the rule. The rule appears as a tag with an x, which you can use to remove the rule later.
-
Click Save at the bottom of the page.