Automatically synchronize WHMCS events to external REST APIs in real-time.
- Real-time event synchronization to external APIs
- Support for POST, PUT, and PATCH requests
- Authentication with custom headers (Bearer tokens, API keys, etc)
- Configurable retry logic with exponential backoff
- Comprehensive logging and statistics
- Connection testing
- Responsive admin dashboard
- Download apisync.zip from the latest release
- Upload to your WHMCS server
- Extract to
/path/to/whmcs/modules/addons/ - In WHMCS Admin Area:
- Go to Setup → Addon Modules
- Find "API Sync" and click Activate
- Click Configure and set Access Control to "Full Administrator"
- Click Save Changes
- Access via Addons → API Sync
- Click "Add Endpoint"
- Enter your API details:
Name: My API Integration URL: https://your-api.example.com/webhook Method: POST - Add authentication headers if needed:
Authorization: Bearer your-token-here - Select events to monitor
- Save and test the connection
Your endpoint will receive JSON data like this:
{
"event": "ClientAdd",
"timestamp": "2025-01-15T10:30:45+00:00",
"data": {
"userid": "123",
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@example.com",
"company": "Acme Corp",
"address": {
"address1": "123 Main St",
"city": "New York",
"state": "NY",
"postcode": "10001",
"country": "US"
},
"phone": "+1234567890",
"currency": "USD"
}
}- Name: Identifier for your endpoint
- URL: Complete API endpoint URL
- HTTP Method: POST, PUT, or PATCH
- Active Status: Enable/disable endpoint
Configure using custom headers:
Authorization: Bearer your-jwt-token
X-API-Key: your-api-key
- Timeout: 1-300 seconds (default: 30)
- Retry Attempts: 0-10 (default: 3)
- Retry Delay: 1-60 seconds (default: 5)
- WHMCS 8.0 or higher
- PHP 8.1 or higher
- cURL and JSON extensions
MIT License - see LICENSE file for details.