đ Overview
This admin guide provides detailed instructions for administrators on how to install, configure, and manage the WhatsApp Notifier extension in Zoho CRM. This guide covers system-level configuration, security settings, user permissions, and maintenance procedures.
Admin Responsibilities
- Installation: Install and configure the extension in Zoho CRM
- Initial Setup: Configure SMSIdea credentials and WhatsApp instances
- User Permissions: Manage who can access and use the extension
- Security: Ensure secure storage of credentials and API keys
- Monitoring: Monitor usage and troubleshoot issues
- Maintenance: Update and maintain the extension
đ§ Installation
Prerequisites
- Zoho CRM administrator account
- Valid SMSIdea account with WhatsApp Business API access
- SMSIdea master key (available in SMSIdea dashboard)
- WhatsApp Business number (verified)
Installation Steps
Navigate to Zoho Marketplace and search for "WhatsApp Notifier". Click "Install" and follow the installation wizard. Alternatively, if you have a private installation URL, use that to install the extension.
During installation, you'll be prompted to grant permissions. The extension requires:
- Access to Zoho CRM Variables (for credential storage)
- Access to Web Tabs (for extension interface)
- Access to Setup pages (for configuration widget)
After installation, verify that the extension is properly installed:
- Check Setup > Extensions > WhatsApp Notifier
- Verify Web Tab "WhatsApp Instances" is visible
- Confirm configuration widget is accessible
Navigate to Setup > Extensions to view the extension status. Ensure it shows as "Active" and there are no error messages.
âī¸ Configuration
Initial Configuration
Before users can use the extension, administrators need to perform initial configuration:
1. Access Configuration Widget
Navigate to Setup > WhatsApp Notifier Configuration to access the configuration widget. This widget allows you to view and manage stored credentials.
2. Configure SMSIdea Master Key
The SMSIdea master key is required for authentication. To configure:
- Log in to your SMSIdea account at wa.smsidea.com
- Navigate to Dashboard > API Settings
- Copy your master key
- Use the Login page in the extension to enter and save the master key
- The master key will be stored in Zoho CRM Variable:
whatsappnotifier__masterkey
3. Connect WhatsApp Instance
Connect your first WhatsApp Business instance:
- Navigate to the Web Tab "WhatsApp Instances"
- Click "Connect New Instance"
- Scan the QR code with your WhatsApp Business account
- Wait for connection confirmation
- The API key will be stored in Zoho CRM Variable:
whatsappnotifier__apikey
CRM Variables
The extension uses the following Zoho CRM Variables to store credentials:
| Variable Name | Purpose | Access Level |
|---|---|---|
whatsappnotifier__masterkey |
Stores SMSIdea master key for authentication | Admin/Authorized Users |
whatsappnotifier__apikey |
Stores default WhatsApp instance API key | Admin/Authorized Users |
Whitelisted Domains
The extension requires the following domains to be whitelisted in Zoho CRM (automatically configured during installation):
https://wa.smsidea.comwa.smsidea.com
These domains are automatically added during installation. If you encounter CORS errors, verify these domains are whitelisted in Setup > Extensions > WhatsApp Notifier > Settings.
đĨ User Management
User Permissions
Control who can access and use the WhatsApp Notifier extension:
Required Permissions
- Web Tabs: Users need access to the "WhatsApp Instances" web tab to use the extension
- CRM Variables: Users need read/write access to extension variables to use features
- Setup Access: Only admins should have access to the configuration widget
Setting User Permissions
- Navigate to Setup > Users & Permissions > Users
- Select the user you want to configure
- Go to the Roles tab
- Assign appropriate role with Web Tab access
- For configuration access, assign Administrator role
Role-Based Access
| Role | Can Send Messages | Can Manage Instances | Can Access Config |
|---|---|---|---|
| Standard User | â | â | â |
| Administrator | â | â | â |
| Read Only | â | â | â |
Best Practices
- Limit configuration access to administrators only
- Provide training to users on proper usage
- Monitor user activity for compliance
- Review permissions regularly
- Revoke access when users leave the organization
đ Security
Credential Storage
All credentials are stored securely in Zoho CRM Variables:
- Master keys and API keys are encrypted at rest
- Access is controlled through Zoho CRM permissions
- Credentials are never exposed in logs or error messages
Security Best Practices
1. Regular Credential Rotation
Regularly rotate your SMSIdea master key:
- Generate new master key in SMSIdea dashboard
- Update in extension configuration
- Verify all instances still work
- Delete old credentials from CRM Variables
2. Access Control
- Limit access to configuration widget to administrators only
- Review user permissions regularly
- Use role-based access control
- Monitor access logs
3. Audit Logging
Enable audit logging for:
- Configuration changes
- Credential updates
- Instance connections/disconnections
- Message sending activities
4. Data Transmission
Compliance
- Ensure compliance with WhatsApp Business API policies
- Follow SMSIdea's terms of service
- Comply with data privacy regulations (GDPR, CCPA, etc.)
- Maintain audit trails for compliance requirements
đ Monitoring
Extension Health Checks
Regularly monitor the extension to ensure it's working correctly:
1. Check Extension Status
Navigate to Setup > Extensions > WhatsApp Notifier to check:
- Extension status (Active/Inactive)
- Last updated timestamp
- Version information
- Error messages (if any)
2. Monitor CRM Variables
Check stored credentials in Configuration Widget:
- Verify master key is set
- Check default API key is configured
- Clear credentials if needed for troubleshooting
3. Test Instance Connections
Regularly test WhatsApp instance connections:
- Verify instances are connected
- Test message sending functionality
- Check for connection errors
Usage Monitoring
- Monitor message sending frequency
- Track instance usage
- Check for error patterns
- Review user activity logs
Performance Metrics
| Metric | How to Monitor | Expected Value |
|---|---|---|
| Extension Load Time | Browser DevTools | < 3 seconds |
| Message Send Success Rate | SMSIdea Dashboard | > 95% |
| Instance Connection Status | Extension Interface | All Connected |
đ§ Troubleshooting
Common Admin Issues
Issue: Extension not appearing in Zoho CRM
- Verify extension is installed: Setup > Extensions
- Check extension status is "Active"
- Clear browser cache and refresh
- Check user permissions for Web Tab access
- Reinstall extension if necessary
Issue: Cannot access configuration widget
- Verify you have administrator privileges
- Check Setup > Extensions > WhatsApp Notifier exists
- Clear browser cache
- Try accessing from different browser
Issue: Credentials not saving
- Check CRM Variables permissions
- Verify you have write access to variables
- Check browser console for errors
- Try clearing and re-entering credentials
Issue: CORS errors when using extension
- Verify whitelisted domains in extension settings
- Check that wa.smsidea.com is whitelisted
- Review extension manifest configuration
- Contact extension support if issue persists
Logs and Debugging
To enable debugging:
- Check browser console for JavaScript errors
- Review Zoho CRM extension logs
- Check SMSIdea API logs in their dashboard
- Enable debug mode by adding
?waDebug=1to extension URLs
Getting Support
If you encounter issues not covered in this guide:
- Contact extension support: [Your Support Email]
- Check extension documentation
- Review Zoho CRM extension logs
- Contact SMSIdea support for API-related issues