Botsplash Direct Links Integration Guide
Overview
Botsplash provides direct URL links that allow developers to integrate customer chat and visitor information directly into their CRM or application systems. These links provide immediate access to customer conversations and activity history without requiring widget embedding.
Base URLs
All direct links use one of the following base URLs:
- Standard:
https://app.botsplash.com - Custom Domain:
https://<client-domain>.botsplash.com(if applicable)
Replace <client-domain> with your specific Botsplash domain if you have a custom setup.
Direct Link Types
1. Chat Dashboard Links
Access customer conversations and chat interface directly:
Using CRM/System Identifier
https://app.botsplash.com/webapi/r/{accountId}/crmid/{clientVisitorId}/inbox
Using Client Application/Account Identifier
https://app.botsplash.com/webapi/r/{accountId}/appid/{clientAppId}/inbox
Using Botsplash ID
https://app.botsplash.com/webapi/r/{accountId}/id/{id}/inbox
2. Visitor Activity Links
View detailed visitor activity and interaction history:
Using CRM/System Identifier
https://app.botsplash.com/webapi/r/{accountId}/crmid/{clientVisitorId}/activity
Using Client Application/Account Identifier
https://app.botsplash.com/webapi/r/{accountId}/appid/{clientAppId}/activity
Using Botsplash ID
https://app.botsplash.com/webapi/r/{accountId}/id/{id}/activity
URL Parameters
| Parameter | Description | Source |
|---|---|---|
{accountId} | Your Botsplash account identifier | Botsplash account settings |
{clientVisitorId} | Customer ID from your CRM/system | Your CRM database |
{clientAppId} | Application-specific customer identifier | Your application database |
{id} | Botsplash internal visitor ID | Botsplash Open API response |
Implementation Examples
1. CRM Integration
HTML Link Integration
<!-- Chat Dashboard Link -->
<a href="https://app.botsplash.com/webapi/r/your-account/crmid/CUSTOMER123/inbox"
target="_blank"
class="botsplash-chat-link">
View Customer Chat
</a>
<!-- Activity Dashboard Link -->
<a href="https://app.botsplash.com/webapi/r/your-account/crmid/CUSTOMER123/activity"
target="_blank"
class="botsplash-activity-link">
View Customer Activity
</a>
JavaScript Dynamic Link Generation
function generateBotsplashLinks(accountId, customerId) {
const baseUrl = 'https://app.botsplash.com';
return {
chat: `${baseUrl}/webapi/r/${accountId}/crmid/${customerId}/inbox`,
activity: `${baseUrl}/webapi/r/${accountId}/crmid/${customerId}/activity`
};
}
// Usage
const links = generateBotsplashLinks('your-account', 'CUSTOMER123');
console.log('Chat Link:', links.chat);
console.log('Activity Link:', links.activity);
Custom Domain Usage
If you have a custom Botsplash domain, replace the base URL:
// Standard domain
const standardUrl = 'https://app.botsplash.com/webapi/r/account/crmid/customer123/inbox';
// Custom domain
const customUrl = 'https://yourcompany.botsplash.com/webapi/r/account/crmid/customer123/inbox';
Troubleshooting
Common Issues
- 404 Not Found
- Cause: Invalid customer ID or account ID
- Solution: Verify customer exists in Botsplash system
- Access Denied
- Cause: User lacks permissions or isn’t authenticated
- Solution: Ensure proper authentication and user permissions
- Invalid URL Format
- Cause: Malformed URL parameters
- Solution: Use the exact URL format specified in this documentation
Support
For questions about direct link integration:
- Verify your account ID and customer identifiers
- Ensure customers exist in your Botsplash system
- Contact Botsplash support for access issues or custom domain setup
- Refer to the Botsplash Open API documentation for ID mapping