Webhook plays a crucial role in providing real-time information through Aloware. Unlike traditional APIs that require frequent polling for data, webhooks deliver data to users immediately or with a slight delay. This makes Aloware's webhook integration more efficient and convenient for users.
Setting up your Webhook Integration
Setting up a webhook in Aloware is a simple process, making it easier than other integrations.
Navigate to the Integrations tab on the left side of Aloware's interface.
Locate the Webhook card, and click on the "Settings" button.
Webhook integration is activated either by creating a valid webhook or by having an existing webhook listing.
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.
The Webhook Settings Page
The Webhooks settings interface displays all created webhooks from Aloware in a list format. The list includes the webhook's name, target (receiver URL), delay in seconds, enabled events, filters, and status (active, disabled, or invalid if the webhook URL endpoint is invalid).
From the Webhook integration interface, you can make changes to an existing webhook by clicking on the three gray dots next to the listed webhook. The available options include Edit, Test & Validate, and Delete.
Edit - this option allows you to modify the details, options, and filters of an active or disabled webhook. A pop-up window will appear, allowing you to make the necessary changes. After modifying the webhook, click "Save & Test Webhook".
Test & Validate - By clicking this button, you can verify the validity and functionality of the webhook's endpoint URL. If the test is successful, the status will show as "Valid & Active" in the "Status" column, and a small window will confirm the webhook's successful test.
Disable - This option deactivates the selected webhook listing. You can still activate or modify the settings of the webhook, and it will remain on the webhook's list.
Delete - This option removes the selected webhook listing from the webhook list.
Adding a New Webhook
To add a new webhook in Aloware, follow these steps:
Navigate to the Webhook integration page, then click the +Add Webhook button.
Then a window will appear where you can enter your new webhook details;
Name - Provide a name for your webhook.
Description - Add a brief description to explain the purpose of the webhook.
URL - Enter the URL where the webhook data will be sent.
Authentication Method - You can select the appropriate authentication method based on your requirements.
None - No authentication required.
Basic - Use basic authentication for secure access.
Bearer - Implement bearer token authentication for authorization.
Delay - Webhooks in Aloware offer rapid data syncing within milliseconds to seconds. The "Delay" option allows you to set a specific time (in seconds) before the data is sent to the webhooks.
Events - The list of event boxes enables you to select the specific data/ information you want to receive on your webhook. You can select individual events or select all events. It is recommended to have one selection per webhook to optimize data organization and efficiency.
Contact Created
When you create a new contact in Aloware, Aloware's webhook triggers this event and sends data and information to your webhooks.
Stay informed about newly added contacts in real-time and take immediate action to ensure your contact database remains up to date.
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.
Filters
We will send filter events upstream to a webhook. If you choose a filter but don't select any options for it, we won't send any events.
Direction
Filter contacts based on communication direction. You can select between "inbound" and "outbound" to receive data specifically for contacts based on the direction of their communications.
Type
Filter contacts based on the communication type. Select from the following options to receive data for specific types of communications:
Call
SMS
RVM
Email
Note
SysNote
Appointment
Reminder
Communication Disposition Status
Filter contacts based on communication disposition status. Select from the following to receive data only for contacts with specific disposition statuses:
Completed
Abandoned
Missed
Failed
Placed
Contacts
This filter allows you to narrow down contacts based on their status. Select from the following options:
All - receive data for all contacts.
Disposed contacts - receive data only for contacts with a disposition assigned.
Selected Disposition - select a specific disposition type (e.g. Attempted Contact, Bad Timing, Connected, etc.) to receive data for contacts with that specific disposition.
Skip Lines
With this filter, you can exclude specific lines that you don't want to receive in your webhooks. This feature allows you to customize the data you receive and exclude irrelevant or unnecessary contact lines.
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 sent 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 mentioned above.
You can enable the filters mentioned above by clicking the "Enable Filters" button. If you select a filter but do not choose any options within it, webhooks will not send any events. Ensure that you configure the filters according to your specific needs and integration requirements.
Click the "Save & Test Webhook" button.
Once you successfully create a webhook, Aloware will send a test log to the webhook to verify its activation, validity, and proper functionality.
Examples:
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"
}