Overview
This guide explains how to whitelist website addresses for your TeamAI chatbots to enhance security and prevent unauthorized use. Whitelisting ensures your chatbot only loads on your specified websites, protecting your resources and usage limits.
Learning Objectives:
Understand the importance of website whitelisting
Follow step-by-step instructions to whitelist website addresses
Learn how to manage multiple whitelisted domains
Prevent unauthorized use of your chatbot resources
Prerequisites
You'll Need:
Access to your workspace with assistant management permissions
The website address(es) where you want to deploy your chatbot
A configured TeamAI assistant ready for deployment
Understanding Whitelisting
How Whitelisting Protects Your Resources
Review the security verification process
TeamAI chatbots are loaded from the server when a request is made
The system verifies the origin of each request before serving the chatbot
If the request origin doesn't match whitelisted addresses, the chatbot won't load
Consider the benefits of whitelisting
Prevents unauthorized use of your chatbot on other websites
Protects your TeamAI account's credit allocation
Provides greater control over where your chatbot appears
Result: Your chatbot resources are secured and only used on your authorized websites.
Important: All TeamAI plans have set limits on the number of credits per account. Without whitelisting, unauthorized use could consume your allocated resources.
Whitelisting Your Website Address
Step-by-Step Configuration
Navigate to the agent section
Look for and click on the "agent" icon in the left sidebar
This displays your list of available agents
Select the specific agent for configuration
Click on the (...) button of the agent you want to configure for whitelisting
This opens the agent's configuration settings
Access the Advanced options
Locate the "Whitelist your websites" option field in the configuration panel
Enter your website address(es)
Type the full address of your website including the protocol (https:// or http://)
For multiple websites, separate each address with a comma
Save your configuration
Click the "Save Changes" button to apply your whitelisting settings
Wait for confirmation that your changes have been saved
Result: Your chatbot will now only load on the websites you've specified in the whitelist.
Tip: For maximum security, use the most specific URL format needed for your implementation.
Managing Multiple Websites
Adding Multiple Domains to Your Whitelist
Navigate to your chatbot's whitelisting settings
Follow the same steps to access the "Whitelist Your Website" field
Enter multiple addresses with proper formatting
Add each website address, separated by commas
Ensure each address is complete and correctly formatted
Example:
https://yourmainsite.com, https://yourothersite.com
Save your multi-domain configuration
Click "Save Changes" to apply the settings
Verify all domains work by testing the chatbot on each site
Note: You can whitelist as many domains as needed for your business requirements.
Best Practices
Use specific domain formats: Consider whether you need to whitelist entire domains or specific subdomains based on your implementation.
Include all variations: If your site uses both www and non-www versions, or both http and https, include all necessary variations in your whitelist.
Periodically review whitelisted domains: Regularly check your whitelist to remove any domains where the chatbot is no longer deployed.
Never leave the whitelist blank: Unless absolutely necessary for testing, always specify at least one domain to prevent unauthorized usage.
Common Questions
Q: What happens if I leave the whitelist field blank?
A: Your chatbot will load on any website where the code snippet is implemented, potentially allowing unauthorized use of your resources.
Q: Can I whitelist an entire domain and all its subdomains?
A: Yes, you can whitelist at the domain level to allow the chatbot on all subdomains, or specify individual subdomains for more granular control.
Q: Will whitelisting affect my chatbot's functionality?
A: No, whitelisting only controls where the chatbot can load. All features and capabilities remain the same on authorized websites.
Q: How do I test my chatbot if I've whitelisted specific domains?
A: Your chatbot will only work on the whitelisted domains. For testing on development environments, temporarily add those domains to your whitelist.
Q: How quickly do whitelisting changes take effect?
A: Changes to your whitelist take effect immediately after publishing, though browser caching may occasionally require a refresh.
Q: Can I use IP addresses instead of domain names?
A: Whitelisting typically works with domain names rather than IP addresses for web-based implementations.