Enabling webhooks
Navigate to Integrations menu in your Aloware admin account.
Locate the webhook card and toggle on the enable button. This will only take effect if there is an active webhook.
Creating a new webhook
Navigate to the webhook integration page, then click the Settings button.
Click the "+Add Webhook" button to set up a new webhook.
In the Add New webhook window, enter the following details:
Name
Description - (optional) add a brief explanation of the webhook's purpose.
URL - enter the URL where the webhook data will be sent.
Authentication method - determines how the webhook will authenticate itself when sending requests to external services.
None - the webhook will not use any specific authentication mechanism, and requests will be sent without credentials.
Basic - the webhook will send a username and password with each request, typically as a base64-encoded string in the Authorization header.
Bearer - the webhook will send a bearer token in the Authorization header to authenticate the API requests.
Delay - Specify the time delay, in seconds, before the webhook sends a request to an external service.
The delay functionality can be useful when you need to introduce a pause or buffer before sending the webhook request to ensure proper synchronization or avoid potential race conditions.
Configure webhook events
The list of event checkboxes allows you to select the specific data and information you want to receive through your webhook. You can choose individual events or select all events as needed. It is recommended to have one event selection per webhook to optimize data organization and efficiency.
Contact created
When a new contact is created in Aloware, this event triggers and sends the contact data to your webhooks.
Stay informed about newly added contacts in real-time and take immediate action to maintain an up-to-date contact database.
Contact updated
Aloware's webhook notifies you when a contact is updated. Whether there are changes to contact details or other relevant information, this event sends data and information about the updated contact to your webhooks.
Stay synchronized with the latest contact updates and maintain accurate records.
Contact disposed
Aloware's webhook sends data and information to your webhooks when there are changes or modifications in a contact's disposition.
Stay updated on status changes for your contacts and promptly respond to any disposition modifications made within your Aloware account.
Contact DNC updated
When a contact is marked as DNC (do not contact) within Aloware, receive a real-time update to an external system of the status.
Communication initiated
Stay informed when communication is initiated with a contact in Aloware.
This webhook event sends data and information to your webhooks as soon as communication is initiated, allowing you to track and manage communication activities effectively.
Communication disposed
When a communication's disposition is changed or modified in Aloware, this webhook event will notify your webhooks.
Stay updated on the disposition changes of your communications, enabling you to monitor the progress and outcomes of your interactions with contacts.
Appointment saved
Aloware will send data and information to your webhooks after saving an appointment.
Stay informed about scheduled appointments and leverage this data to manage your calendar, plan follow-ups, and streamline your appointment workflow.
Call disposed
After selecting a disposition for a call in Aloware, this webhook event will send data and information to your webhooks.
Keep track of call dispositions, analyze call outcomes, and utilize this information to enhance your calling strategies and customer interactions.
Voicemail saved
This webhook event notifies your webhooks when a voicemail is saved in Aloware.
Stay informed about received voicemails and use this data to manage voicemail responses, follow up with contacts, and improve overall communication efficiency.
Recording saved
After saving a recording from a call in Aloware, this webhook event will send data and information to your webhooks.
Stay updated on call recordings, utilize them for quality assurance, training purposes, or compliance needs, and ensure you have a comprehensive record of your conversations.
The "transcription saved" webhook event indicates that a transcription of an interaction has been successfully saved in Aloware.
This means that when a communication (such as a phone call) is transcribed into text, the resulting transcription is saved and made available for further processing or accessed by other systems or users. This event provides a trigger to notify other systems or stakeholders that a transcription has been completed and is available for use.
Call summarized
This event triggers when a call transcription is successfully summarized and saved in Aloware. It provides details such as the transcription ID, summary content, timestamp, related communication ID, and contact information. This allows external systems to process summarized call data in real-time, enabling actions like CRM updates, workflow automation, or analytics tracking.
Utilize webhook filters (optional)
To enable the filters, click the "Enable Filters" button. Ensure that you configure the filters according to your specific needs and integration requirements. If you select a filter but don't choose any options for it, Aloware won't send any events for that filter.
Direction
Filter contacts based on the communication direction (inbound or outbound) to receive data specifically for contacts based on the direction of their communications.
Type
Filter contacts based on the communication type, such as Call, SMS, RVM (Ringless Voicemail), Email, Note, SysNote, Appointment, or Reminder.
Communication Disposition Status
Filter contacts based on the communication disposition status, such as Completed, Abandoned, Missed, Failed, or Placed.
Contacts
Filter contacts based on their status:
All - Receive data for all contacts.
Disposed contacts - Receive data only for contacts with a disposition assigned.
Selected disposition - Receive data for contacts with a specific disposition (e.g., Attempted Contact, Bad Timing, Connected).
Skip Lines
Exclude specific contact lines from the webhook data, allowing you to customize the information you receive and omit irrelevant or unnecessary details.
Duration
Filter contacts based on the duration or talk time of their communications. Specify a minimum duration in minutes, and only contacts with a duration less than the specified value will be included in the webhooks.
Qualified Contacts
This filter ensures that only contacts meeting specific criteria are created and sent in the webhooks. The webhook will trigger data transmission only when a qualified communication from a contact passes all the selected and modified filters.
Testing and verifying webhook setup
Click the "Save & Test Webhook" button to send a test log and ensure the webhook is properly configured and functional.
How agents can use webhooks
Agents do not configure webhooks but can benefit from automated workflows. For example, webhooks can be used to send notifications when a new lead is added, log call details in an external system, and trigger an action based on customer interaction.
Webhook event examples
Here are some sample webhook payloads to give you a better understanding of the data you can expect:
Outbound call made:
{
"body": {
"id": "54363660",
"company_id": "47",
"campaign_id": "2803",
"ring_group_id": "",
"owner_id": "42",
"user_id": "42",
"workflow_id": "",
"broadcast_id": "",
"incoming_number_id": "6648",
"incoming_number": "+18186006750",
"contact_id": "6896898",
"call_disposition_id": "",
"lead_number": "+18552562001",
"target_users": "",
"attempt": "",
"attempting_users": "",
"destination_number": "client:agent42",
"transfer_prior_user_ids": "",
"transfer_target_user_ids": "",
"in_cold_transfer": "",
"direction": "2",
"type": "1",
"is_read": "",
"recorded_file_is_migrated": "",
"voicemail_is_migrated": "",
"legc_uuid": "",
"legc_status": "",
"first_time_caller": "0",
"body": "",
"attachments": "",
"conference_status2": "10",
"current_status": "completed",
"current_status2": "9",
"disposition_status": "completed",
"disposition_status2": "4",
"resolution2": "1",
"callback_status": "",
"transfer_type": "",
"rejected_by_app": "0",
"duration": "14",
"talk_time": "12",
"wait_time": "4",
"csat_score": "0",
"notes": "",
"country": "US",
"state": "US",
"city": "tollfree",
"engagement_data": "",
"created_at": "2021-04-23 00:22:28",
"updated_at": "2021-04-23 00:22:45",
"has_recording": "",
"has_voicemail": "",
"direct_voicemail_url": "",
"direct_recording_url": "",
"call_disposition": "",
"contact": {
"id": "6896898",
"company_id": "47",
"user_id": "2603",
"initial_campaign_id": "",
"disposition_status_id": "7327",
"lead_source_id": "",
"intake_source": "hubspot",
"phone_number": "+18552562001",
"company_name": "Aloware",
"email": "",
"first_name": "Aloware",
"last_name": "Main line",
"timezone": "America/Chicago",
"external_data": "",
"csf1": "",
"csf2": "",
"unread_count": "2",
"cnam_source": "",
"cnam_city": "tollfree",
"cnam_state": "US",
"cnam_zipcode": "",
"cnam_country": "US",
"address": "",
"website": "",
"notes": "",
"date_of_birth": "",
"last_engagement_at": "2021-04-23 00:22:28",
"last_engagement_text": "↗ (Anoosh R) Call.",
"nb_communications": "108",
"inbound_call_count": "65",
"outbound_call_count": "52",
"inbound_sms_count": "3",
"outbound_sms_count": "2",
"unread_voicemail_count": "0",
"unread_missed_call_count": "1",
"lrn_type": "3",
"is_blocked": "",
"is_dnc": "",
"uuid_v4": "1ddc5d62-bbeb-44ef-814f-b728ad649449",
"text_authorized": "0",
"text_authorized_at": "",
"thread_status": "0",
"workflow_id": "",
"created_at": "2020-04-20 04:21:40",
"updated_at": "2021-04-23 00:22:45",
"name": "Aloware Main line",
"first_communication_campaign_id": "2174",
"last_communication_campaign_id": "2803",
"lead_source": "",
"job_title": "",
"product_id": "",
"disposition_status": "Converted"
}
},
"event": "OutboundPhoneCall-DispositionCompleted"
}Abandoned inbound call
{
"body": {
"id": "54363661",
"company_id": "47",
"campaign_id": "47",
"ring_group_id": "",
"owner_id": "2618",
"user_id": "",
"workflow_id": "",
"broadcast_id": "",
"incoming_number_id": "46",
"incoming_number": "+18552562001",
"contact_id": "6897588",
"call_disposition_id": "",
"lead_number": "+18186006750",
"target_users": "",
"attempt": "",
"attempting_users": "",
"destination_number": "",
"transfer_prior_user_ids": "",
"transfer_target_user_ids": "",
"in_cold_transfer": "",
"direction": "1",
"type": "1",
"is_read": "",
"recorded_file_is_migrated": "",
"voicemail_is_migrated": "",
"legc_uuid": "",
"legc_status": "",
"first_time_caller": "0",
"body": "",
"attachments": "",
"conference_status2": "",
"current_status": "completed",
"current_status2": "9",
"disposition_status": "abandoned",
"disposition_status2": "2",
"resolution2": "1",
"callback_status": "",
"transfer_type": "",
"rejected_by_app": "0",
"duration": "14",
"talk_time": "0",
"wait_time": "14",
"csat_score": "0",
"notes": "System: line was closed and redirected to terminate.\n",
"country": "US",
"state": "CA",
"city": "LOS ANGELES",
"engagement_data": "",
"created_at": "2021-04-23 00:22:31",
"updated_at": "2021-04-23 00:22:46",
"has_recording": "",
"has_voicemail": "",
"direct_voicemail_url": "",
"direct_recording_url": "",
"call_disposition": "",
"contact": {
"id": "6897588",
"company_id": "47",
"user_id": "2618",
"initial_campaign_id": "",
"disposition_status_id": "",
"lead_source_id": "",
"intake_source": "hubspot",
"phone_number": "+18186006750",
"company_name": "",
"email": "",
"first_name": "Aloware Contact",
"last_name": "(+18186006750)",
"timezone": "America/Los_Angeles",
"external_data": "",
"csf1": "",
"csf2": "",
"unread_count": "1",
"cnam_source": "",
"cnam_city": "Los Angeles",
"cnam_state": "CA",
"cnam_zipcode": "90013",
"cnam_country": "US",
"address": "",
"website": "",
"notes": "",
"date_of_birth": "",
"last_engagement_at": "2021-04-23 00:22:31",
"last_engagement_text": "↙ Call.",
"nb_communications": "14",
"inbound_call_count": "14",
"outbound_call_count": "2",
"inbound_sms_count": "1",
"outbound_sms_count": "0",
"unread_voicemail_count": "0",
"unread_missed_call_count": "0",
"lrn_type": "0",
"is_blocked": "",
"is_dnc": "",
"uuid_v4": "0304c414-b908-4b11-9dd7-135a4fe810a4",
"text_authorized": "0",
"text_authorized_at": "",
"thread_status": "3",
"workflow_id": "",
"created_at": "2020-04-20 04:22:16",
"updated_at": "2021-04-23 00:22:33",
"name": "Aloware Contact (+18186006750)",
"first_communication_campaign_id": "47",
"last_communication_campaign_id": "47",
"lead_source": "",
"job_title": "",
"product_id": "",
"disposition_status": ""
}
},
"event": "InboundPhoneCall-DispositionAbandoned"
}Outbound SMS
{
"body": {
"id": "45486",
"company_id": "7",
"campaign_id": "497",
"ring_group_id": "",
"owner_id": "547",
"workflow_id": "",
"broadcast_id": "",
"incoming_number_id": "508",
"incoming_number": "+12058592382",
"contact_id": "182948",
"call_disposition_id": "",
"lead_number": "+14243942058",
"target_users": "",
"attempt": "",
"attempting_users": "",
"user_id": "547",
"destination_number": "",
"transfer_prior_user_ids": "",
"transfer_target_user_ids": "",
"in_cold_transfer": "",
"direction": "2",
"type": "2",
"is_read": "1",
"recorded_file_is_migrated": "",
"voicemail_is_migrated": "",
"legc_uuid": "",
"legc_status": "",
"first_time_caller": "0",
"body": "test 2",
"attachments": "",
"conference_status2": "",
"current_status": "delivered",
"current_status2": "13",
"disposition_status": "completed",
"disposition_status2": "4",
"resolution2": "1",
"callback_status": "",
"transfer_type": "",
"rejected_by_app": "0",
"duration": "1",
"talk_time": "0",
"wait_time": "0",
"csat_score": "0",
"notes": "",
"country": "US",
"state": "CA",
"city": "Alhambra",
"engagement_data": "",
"created_at": "2021-07-19 16:00:34",
"updated_at": "2021-07-19 16:00:36",
"has_recording": "",
"has_voicemail": "",
"direct_voicemail_url": "",
"direct_recording_url": "",
"call_disposition": "",
"contact": {
"id": "182948",
"company_id": "7",
"user_id": "547",
"initial_campaign_id": "10",
"disposition_status_id": "181",
"lead_source_id": "",
"intake_source": "hubspot-webhook",
"phone_number": "+14243942058",
"company_name": "Aloware",
"email": "[email protected]",
"first_name": "Sohrab",
"last_name": "Cell",
"timezone": "America/Los_Angeles",
"external_data": "",
"csf1": "",
"csf2": "",
"unread_count": "0",
"cnam_source": "",
"cnam_city": "Alhambra",
"cnam_state": "CA",
"cnam_zipcode": "",
"cnam_country": "US",
"address": "",
"website": "",
"notes": "",
"date_of_birth": "",
"last_engagement_at": "2021-07-19 16:00:34",
"last_engagement_text": "↗ (Sohrab Sheikhani) test 2.",
"nb_communications": "56",
"inbound_call_count": "6",
"outbound_call_count": "44",
"inbound_sms_count": "2",
"outbound_sms_count": "4",
"unread_voicemail_count": "0",
"unread_missed_call_count": "0",
"lrn_type": "1",
"is_blocked": "",
"is_dnc": "",
"uuid_v4": "ee5650db-f1ac-4373-a78c-ba9ad3bd9a35",
"text_authorized": "0",
"text_authorized_at": "",
"thread_status": "0",
"workflow_id": "",
"created_at": "2021-06-14 21:38:10",
"updated_at": "2021-07-19 16:00:37",
"sequence_id": "",
"name": "Sohrab Cell",
"first_communication_campaign_id": "10",
"last_communication_campaign_id": "497",
"lead_source": "",
"year": "",
"make": "",
"model": "",
"price": "",
"stock": "",
"vin": "",
"handsome_level": "",
"weight": "",
"disposition_status": "Open"
}
},
"event": "OutboundSMS-DispositionCompleted"
}