🔗 Webhooks
Webhooks enable real-time communication between AI Sync and external systems by sending HTTP POST requests when specific events occur in your system.🎯 Overview
Webhooks provide instant notifications about important events in your AI Sync system, allowing you to build powerful integrations and automated workflows.
Real-time Notifications
Receive instant updates when events occur in your system
External Integrations
Connect with CRMs, databases, and third-party applications
Automated Workflows
Trigger actions in external systems based on AI Sync events
Data Synchronization
Keep external systems in sync with your AI Sync data
🔄 Webhook Workflow
1
Event Occurs
An action happens in AI Sync (call ends, agent responds, etc.)
2
Webhook Triggered
System identifies configured webhooks for the event type
3
HTTP Request Sent
POST request with event data sent to your endpoint URL
4
Response Processed
Your system processes the data and sends acknowledgment
5
Retry Logic
Failed requests are retried with exponential backoff
📋 Webhook Management
Navigate to Setup > Webhooks to manage your webhook configurations.
Webhook Table Overview
Column | Description | Example |
---|---|---|
# | Sequential webhook ID | 1 , 2 , 3 |
Title | Webhook name/identifier | CRM Integration , Analytics Sync |
Hits | Total number of webhook calls | 1,247 |
Last Hit | Most recent webhook execution | 2025-01-15 14:30:25 |
Created At | Webhook creation timestamp | 2025-01-10 10:40 PM |
Action | Management options | Edit, Delete, View Endpoints |
Quick Actions
Add New Webhook
Create new webhook endpoints for your integrations
Edit Configuration
Modify existing webhook settings and URLs
View Endpoints
Monitor webhook performance and delivery status
🎛️ Webhook Configuration
Creating a New Webhook
1
Click Add Webhook
Navigate to Setup > Webhooks and click the “Add” button
2
Configure Basic Settings
- Title: Descriptive name for the webhook
- URL: Your endpoint URL to receive webhook data
- Method: HTTP method (typically POST)
3
Select Event Types
Choose which events should trigger this webhook
4
Configure Authentication
Set up security headers and authentication tokens
5
Test and Activate
Test the webhook and activate it for live events

Authentication & Security
API Key Authentication
API Key Authentication
Signature Verification
Signature Verification
IP Whitelisting
IP Whitelisting
AI Sync Webhook IPs:
192.168.1.100
192.168.1.101
192.168.1.102
🎪 Available Webhook Events
📞 Call Events
Call Started
Event:
call.started
Triggered: When a call beginsUse Cases: Call logging, real-time monitoringCall Ended
Event:
call.ended
Triggered: When a call completesUse Cases: Call analytics, CRM updatesCall Answered
Event:
call.answered
Triggered: When a call is answeredUse Cases: Connection tracking, response ratesCall Transferred
Event:
call.transferred
Triggered: When a call is transferredUse Cases: Transfer logging, agent routing🤖 Agent Events
Agent Created
Event:
agent.created
Triggered: When a new AI agent is createdUse Cases: Inventory management, provisioningAgent Updated
Event:
agent.updated
Triggered: When agent configuration changesUse Cases: Configuration sync, audit trailsAgent Status Changed
Event:
agent.status_changed
Triggered: When agent goes online/offlineUse Cases: Availability tracking, monitoringAgent Performance
Event:
agent.performance
Triggered: Performance threshold eventsUse Cases: Quality monitoring, alerts📊 Campaign Events
Campaign Started
Event:
campaign.started
Triggered: When a campaign beginsUse Cases: Campaign tracking, notificationsCampaign Completed
Event:
campaign.completed
Triggered: When a campaign finishesUse Cases: Results processing, reportingLead Generated
Event:
lead.generated
Triggered: When a new lead is createdUse Cases: CRM integration, lead routingAppointment Scheduled
Event:
appointment.scheduled
Triggered: When an appointment is bookedUse Cases: Calendar sync, confirmations💬 SMS Events
SMS Sent
Event:
sms.sent
Triggered: When an SMS is deliveredUse Cases: Delivery tracking, billingSMS Received
Event:
sms.received
Triggered: When an SMS is receivedUse Cases: Response handling, conversationsSMS Failed
Event:
sms.failed
Triggered: When SMS delivery failsUse Cases: Error handling, retry logicSMS Replied
Event:
sms.replied
Triggered: When recipient replies to SMSUse Cases: Conversation tracking, engagement📦 Webhook Payload Structure
Standard Payload Format
All webhooks follow a consistent JSON structure:Call Event Payload Example
🔒 Security Best Practices
Webhook Verification
Signature Verification
Signature Verification
Always verify webhook signatures to ensure authenticity:
Rate Limiting
Rate Limiting
Implement rate limiting to prevent abuse:
HTTPS Only
HTTPS Only
Always use HTTPS endpoints for webhook URLs:
Error Handling
Retry Logic
Retry Logic
AI Sync implements exponential backoff for failed webhooks:
- Attempt 1: Immediate
- Attempt 2: 30 seconds delay
- Attempt 3: 2 minutes delay
- Attempt 4: 8 minutes delay
- Attempt 5: 32 minutes delay
- Final: Webhook marked as failed after 5 attempts
Response Codes
Response Codes
Return appropriate HTTP status codes:
📊 Monitoring & Debugging
Webhook Logs
Monitor webhook delivery and performance:Delivery Status
- Success/failure rates
- Response times
- Error codes and messages
- Retry attempts
Performance Metrics
- Average response time
- Peak load handling
- Throughput statistics
- Error rate trends
Testing Webhooks
Test Endpoint
Test Endpoint
Use tools like ngrok for local testing:
Mock Payloads
Mock Payloads
Test with sample webhook payloads: