In this article
Overview
Webhooks are a way for Aloware to provide real-time information. A webhook delivers data to others from Aloware as it happens, meaning you get data immediately (or with a delay). Unlike typical APIs, where you would need to poll for data very frequently in order to get it in real-time. This makes Aloware’s webhook integration much more efficient for the users.
Webhooks Integration
Setting up Webhooks in Aloware is easier than other integrations; first, go to the Integrations tab in the foremost left of Aloware’s interface, then find the Webhooks card, and click the “Settings” button. Webhook integration will only be activated after creating a valid Webhook or if there's an existing Webhook listing.
Note: You can also enable Webhook integration by clicking the enable button from the Webhooks integration card, if and only if there's an active and valid listed Webhook/s.
From the Webhooks settings interface, you will see all the created Webhooks from Aloware in a list form. In the list, Webhook’s name, target (Webhook’s receiver URL), number of seconds to delay, events, filters that have been enabled, status if it’s active, disabled, or invalid (if the Webhook URL endpoint is invalid) are visible in a column form.
Lastly, from the Webhook integration interface, you can revise an existing Webhook by clicking the three gray dots in the right part of a listed Webhook. Edit, Test & Validate, Disable and Delete.
Edit - basically, in this setting, you can edit or modify an active/disabled Webhook's details, options, and filters that you want to change; a window will pop-up up where you can edit/modify everything, and after your modifications, click "Save & Test Webhook."
Test & Validate - This button lets you verify the validity of your Webhook's endpoint URL if it's valid and working. (You will see the status "Valid & Active" in the "Status" column, and a small window will pop up that says your Webhook test is passed.)
Disable - This disables the selected Webhook listing, you can still activate or modify the settings of the Webhook, and it stays in the Webhook's lists.
Delete - This deletes/removes the selected Webhook listing in the Webhook lists.
Adding a New Webhook
Adding a new Webhook in Aloware is easy. In the Webhook integration page, click the Add Webhook in the top-right part of the interface, then a window will appear where you can enter your new Webhook’s details; Name, Description, URL, Authentication Method, Delay, Events, Filters, and after filling the Webhook's information, editing its filters and events, click "Save & Test Webhook".
Note: After successfully creating a Webhook, Aloware will send a test log to Webhook for you to determine if your created list is active, valid, and it's functioning properly.
Authentication Method
None
Basic
Bearer
Delay
As stated above, Webhooks data syncing happens in just a matter of milliseconds to seconds. “Delay” lets you set a time (in seconds) before it sends the data to Webhooks.
Events
This list of events boxes lets you choose what data/information you want to receive on your Webhook. You can select a single classification or all of it. We suggest that one selection in one Webhook for you to organize and maximize your efficiency in locating the data/information that you want to edit or see in Webhook.
Contact Created - Aloware will send data/information to Webhooks when a new contact is created.
Contact Updated - Aloware will send data/information to Webhooks when a contact is updated; it may be the details, etc.
Contact Disposed - Aloware will send data/information to Webhooks when a contact’s disposition has been changed or modified.
Communication Initiated - Aloware will send data/information to Webhooks when communication to a contact has been initiated.
Communication Disposed - Aloware will send data/information to Webhooks when a communication’s disposition has been changed or modified.
Call Disposed - Aloware will send data/information to Webhooks after selecting a disposition to a call.
Voicemail Saved - Aloware will send data/information to Webhooks after saving a voicemail.
Recording Saved - Aloware will send data/information to Webhooks after saving a recording from a call.
Filters
Direction – Filter contacts by communication direction, either inbound, outbound, or both.
Type – Filter contacts by communication type, call, SMS, RVM, email, note, Sys note, appointment, and reminder. You can select all or just one.
Communication Disposition Status – Filter contacts by disposition status, Completed, Abandoned, Missed, Failed, and Placed.
Contacts – Filter by contact type, either you want All the contacts, disposed contacts, or just select a disposition type; Attempted Contact, Bad Timing, Connected, Contact in Future, Contacted, etc.
Skip Lines – Here, you can exclude the contact line/s that you don’t want to send in Webhooks.
Duration – This filter lets you select only the contacts based on the duration or talk time that is less than a certain period of minutes. (You can edit the minimum duration of the minutes to filter.
Qualified Contacts – Here, this filter will only create contacts when a qualified communication from a contact passes all the filters selected and modified above.
Note: The filters above can only be selected once you click the “Enable Filters.” Also, if you select a filter but no options for that filter are selected, no events will be sent.
Examples:
Here is an example of an 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"
}
And here is an example of an 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"
}
Here is an example of 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": "sohrab@aloware.com",
"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"
}