Call Webhooks
Introduction
Marketing Edge Webhooks allow you to register endpoints to receive HTTP requests with Call Data. You can create new Webhooks by configuring them within the Marketing Edge portal. Note that this requires Administrator access.
Types of Webhooks
Call Preprocessed (Post-Call Webhook) - The Call Preprocessed webhook executes immediately after the phone call has completed. It contains the partial data about the call, as described below.
Call Processed (Call Modified Webhook) - The Call Processed webhook is sent when a call has been updated after it has ended to include caller information, scoring and transcribing the call, and when the call recording is available for review.
Additional Post Call Processing
Some post call processing which can incur lengthy delays are either not currently supported (Conversion Ingestion events), or use dedicated webhooks (Sales Rescue)
Call Start - The Call Start webhook is sent as soon as a call is made to a Tracking Number. This webhook will contain name and address matching (when available), as well as attribution details
Configuration
You can also configure webhooks within the client account under the “Settings” -> “Webhooks” menu. You can configure a callback URL that we will send an HTTP POST request to after each call is completed. Additionally, any time a call object is modified within the call log, we will send an HTTP POST request to the given URL as well. This allows you to avoid polling our API endpoints for updates to inbound calls.
Sample Response - Call Details Webhook
{
"Id": "3071d2dae4b24d619afad2eddcd05e7b",
"Attempt": 1,
"Properties": {
"CollectionType": "CallDetails",
"UTC": "2019-11-15T14:10:03.252",
"Organization": "4062",
"RequestId": "e9b2d7c1-5876-4f83-a887-52dc7eb55566"
},
"Notifications": [
{
"Action": "CallDetails.CallPreprocessed",
"OrganizationId": 4062,
"Incomplete": true,
"TelmetricsId": 2079571437,
"TelmetricsStudyID": 8470718,
"CalledNumber": "8669592359",
"TerminationNumber": "9052198236",
"StartTime": "2019-11-15T09:09:54",
"AnswerTime": "2019-11-15T09:09:56",
"EndTime": "2019-11-15T09:10:03",
"MonitorStartTime": "2019-11-15T14:09:53.564",
"MonitorEndTime": "2019-11-15T14:10:02.972",
"AnswerStatus": 1,
"SmsResponse": null,
"RingCount": 1,
"CallSeconds": 7,
"CallerNumber": "9055552955",
"TimeZone": "Eastern",
"RegisteredDNC": null,
"CallerName": "John Smith",
"CallerStreet": "2220 Marine Drive",
"CallerCity": "Lansing",
"CallerState": "MI",
"CallerZip": "40293",
"CallerAddress": "2220 Marine Drive, Lansing, MI, 40293",
"CallerType": null,
"VoiceRecordID": null,
"Latitude": null,
"Longitude": null,
"VoiceRecordingUrl": null,
"VoiceMailDetected": null,
"VoiceTrends": null,
"RouteKey": null,
"SegmentName": null,
"CallTranscript": null,
"OrgGroupID": 4062,
"OrgGroupName": "ABC Company",
"MonitorStartTime": null,
"MonitorEndTime": null,
"CallTags": {
"TagIDs": []
},
"StudyDetails": {
"StudyID": 8470718,
"CustomID": "",
"CustomText": "",
"CustomText2": "",
"CustomText3": ""
},
"AdDetails": {
"AdDefinitionID": 4250816,
"CustomID": "",
"CustomText": "",
"CustomText2": "",
"CustomText3": "",
"CustomText4": "",
"AdDefinitionName": "ABC Company"
},
"AdvertiserDetails": {
"AdvertiserID": 5969255,
"ClientCode": "",
"CustomText": "",
"CustomText2": "",
"AdvertiserName": "Always Avacado DNI Demo"
},
"AttributionDetails": null
}
]
}
{
"HttpMethod": "POST",
"URL": "http://win5ui1:80/receive",
"Headers": {
"Connection": "Keep-Alive",
"Content-Length": "709",
"Content-Type": "application/json; charset=utf-8",
"Expect": "100-continue",
"Host": "win5ui1",
"ms-signature": "sha256=E82C1574D449EEAC07E6532F29A14370EB03FB7589B7DD8F4FA53189BCD9F2EB",
"x-PublicKey": "4662F088F821DF150AD475B678CB723E",
"x-Source-system": "Telmetrics Inc."
},
"RequestBody": {
"Id": "647e8029bf9e432582bd746e9f8ee6d9",
"Attempt": 1,
"Properties": {
"CollectionType": "CallDetails",
"UTC": "2016-05-04T17:17:41"
},
"Notifications": [
{
"Action": "CallDetails.CallProcessed",
"TelmetricsId": 1793078638,
"TelmetricsStudyID": 7232746,
"CalledNumber": "6123159846",
"TerminationNumber": "9052198287",
"StartTime": "2016-05-04T13:17:24",
"AnswerTime": "2016-05-04T13:17:32",
"EndTime": "2016-05-04T13:17:42",
"MonitorStartTime": "2016-11-15T14:09:53.564",
"MonitorEndTime": "2016-11-15T14:10:02.972",
"AnswerStatus": "Answered",
"RingCount": 2,
"CallSeconds": 10,
"CallerNumber": "4167370693",
"CallerName": "",
"CallerStreet": "",
"CallerCity": "TORONTO",
"CallerState": "ON",
"CallerZip": "",
"CallerAddress": "TORONTO ON",
"TimeZone": "Eastern",
"Incomplete": true,
"OrgGroupId": 1234,
"VoiceRecordingUrl": "https://win5CalltelligenceAPI.telmetrics.com/filedownload.ashx/58836a43-69a8-463d-85cf-f16275468e9d/1793078638.mp3",
"VoiceMailDetected": false,
"VoiceTrends": {
"Lead": null,
"VoiceMail": null
},
"CallTranscript": "Caller: And put on Agent: Come Caller: our DO Agent: for Caller: NOT Agent: a moment Caller: CALL Agent:. Caller: LIST press 1 to speak with someone about possibly extending or reinstating your car's warranty again and press 1 to speak with a warranty specialist. ",
"CallSummary": "Agent describing the company and enumerate the routing possibilities to the caller.",
"SentimentSuite": {
"satisfied": false,
"frustrated": false,
"sentiment": "neutral",
"view_of_business": "negative",
"view_of_business_reason": "The caller did not have a substantial conversation with the agent and seemed dissatisfied with the outcome.",
"concern_class": "other - misinterpretation of caller's sentiment",
"sentiment_summary": "The caller expressed gratitude and appreciation multiple times, which indicates a positive interaction. The mention of charges being well received also suggests satisfaction with the service provided."
},
"ConversationAnalytics": {
"LeadOutcome": {
"LeadReason": "Appointment Booked",
"Appointment": "true",
"Lead": "true",
"Sale": "false" // Only Supported for AutoServices Industry Signals
},
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
//LeadValue is Dynamically populated based on configured industry signals
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
//LeadValue for Dental
"LeadValue": {
"InsuranceDiscussed": "false",
"InsuranceProvider": "n/a",
"InsuranceReferral": "false",
"OtherProductOrService": [
"n/a"
],
"CustomerType": "new",
"ProductOrService": [
"orthodontia"
]
},
//Lead Value for Home Services
"LeadValue": {
"ServiceLine": "exterior",
"ProductOrService": [
"doors",
"windows"
],
"CustomerType": "new",
"MaintenanceOrNewSystem": "n/a",
"AgeOver10Years": "n/a"
},
//Lead Value for Automotive Services
"LeadValue": {
"ProductOrService": [
"Warranty"
],
"OtherProductOrService": [
"N/A"
]
},
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
//Topics are Dynamically populated based on configured industry signals
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
//Topics for Dental
"Topics": {
"PricingDiscussed": "false",
"SchedulingDiscussed": "true",
"WalkInDiscussed": "false",
"OtherTopics": []
},
//Topics for Home Services
"Topics": {
"PricingDiscussed": "false",
"SchedulingDiscussed": "true",
"OtherTopics": [
"hours or location"
]
},
//Topics for Automotive Services
"Topics": {
"PricingDiscussed": "true",
"SchedulingDiscussed": "false",
"OtherTopics": [],
"RecallDiscussed": "true",
"WarrantyDiscussed": "true"
}
},
"keyword_lists": [
{
"keyword_list": [
{
"id": 234,
"name": "ListA",
"keywords": [
{
"keyword": "car",
"agent": "00:00:00|00:01:04",
"caller": "00:00:00|00:00:03"
},
{
"keyword": "bus",
"agent": "00:00:00|00:01:04",
"caller": "00:00:00|00:00:03"
}
]
},
{
"id": 234,
"name": "ListB",
"keywords": [
{
"keyword": "plane",
"agent": "00:00:00|00:01:04",
"caller": "00:00:00|00:00:03"
},
{
"keyword": "train",
"agent": "",
"caller": "00:00:00|00:00:03"
}
]
}
]
}
],
"StudyDetails": {
"StudyID": 1234,
"CustomID": 1234,
"CustomText": "1234",
"CustomText2": "1234",
"CustomText3": "1234"
},
"AdDetails": {
"AdDefinitionId": 1234,
"CustomID": 1234,
"CustomText": "1234",
"CustomText2": "1234",
"CustomText3": "1234",
"CustomText4": "1234"
},
"AdvertiserDetails": {
"AdvertiserId": 1234,
"ClientCode": 1234,
"CustomText": "1234",
"CustomText2": "1234"
},
"AttributionDetails": {
"SessionId": 999,
"RuleDescription": "abc - google.com",
"LandingPagURL:": "http://test.com?utm=...",
"ReferrerURL": "google.com",
"MultisessionFlag": true,
"utm_campaign": "testcampaign",
"utm_term": "testing",
"utm_source": "google",
"utm_medium": "search",
"utm_content": "banner1",
"ip_address": "192.168.0.1",
"user_agent": "mozilla 11.4",
"session_tag": {
"tag_id": 1293291,
"tag_data": "sample tag data",
"tag_time": "2016-05-04T13:17:24"
}
}
}
]
}
}
{
"Id": "5eead1ab66254c5a89dfd0a2b0d4248e",
"Attempt": 1,
"Properties": {
"CollectionType": "CallDetails",
"UTC": "2019-11-15T14:09:52.267",
"Organization": "4062",
"RequestId": "ba359b4e-18ca-497b-bd3e-c6570f254139"
},
"Notifications": [
{
"Action": "CallDetails.CallStartCall",
"CallDate": "2019-11-15T14:09:45.591",
"CalledNumber": "8669592359",
"CallerNumber": "9055802958",
"OrgGroupName": "Telmetrics Demo",
"OrgGroupID": 4062,
"OrganizationID": 4062,
"RouteKey": null,
"CallerDetails": {
"PhoneNumber": "9055802958",
"Name": "ONTARIO CALLER",
"Address": null,
"City": null,
"Zip": null,
"State": null,
"ShortZip": null,
"RichData": null
},
"StudyDetails": {
"StudyID": 8470718,
"CustomID": null,
"CustomText": null,
"CustomText2": null,
"CustomText3": null
},
"AdDetails": {
"AdDefinitionID": 4250816,
"CustomID": null,
"CustomText": null,
"CustomText2": null,
"CustomText3": null,
"CustomText4": null
},
"AdvertiserDetails": {
"AdvertiserID": 5969255,
"ClientCode": null,
"CustomText": "",
"CustomText2": ""
},
"AttributionDetails": {
"SessionId": "eb74e7c6-36ae-434e-a6b6-0b977440db1e",
"RuleDescription": "Global Replacement - Toll Free",
"LandingPageUrl": "http://123company.net/",
"ReferrerUrl": "",
"ip_address": "74.112.125.5",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.87 Safari/537.36",
"session_tag": null
}
}
]
}
Sample Response - Call Details(v5-beta) Webhook
{
"Id": "057f409d-6185-4898-bd1d-76a09c83ef02",
"Attempt": 1,
"Properties": {
"CollectionType": "CallDetailsV5",
"UTC": "2025-02-26T21:43:11.888",
"Organization": "5440",
"RequestId": "bef2856b-0e76-4fc3-a2f8-340fcd060fde"
},
"Notifications": [
{
"Action": "CallDetailsV5.CallPreprocessed",
"id": 2482086262,
"call_type_id": 1,
"call_type": "Standard",
"number_id": 13618259,
"group_id": 15117797,
"group_name": "ABC Windows and Doors - Google Ads",
"time_zone_id": 2,
"time_zone_name": "Eastern",
"group_owner_id": 7187041,
"study_name": "Google Ad",
"group_owner_name": "ABC Windows And Doors",
"billing_group_id": 56876,
"billing_group_name": "Level 2",
"number_pool_id": null,
"caller_identity": 474387804,
"organization_id": 5440,
"answer_status_id": 1,
"answer_status": "answered",
"ring_duration": 3,
"call_duration": 30,
"registered_DNC": false,
"tracking_number": "8332795145",
"caller_number": "9055802283",
"termination_number": "9056372483",
"caller_details": {
"name": "Ted Robertson",
"address": "2220 marine Drive",
"city": "Springfield",
"state": "IL",
"zip_code": "29293"
},
"conversation_analytics": null,
"attribution_details": {
"session_identifier": "5aee13c2-1633-4ea6-bddb-145d355159df",
"session_id": "2386840770",
"rule_description": "Google Paid",
"rule_id": 464255,
"utm_source": "",
"utm_medium": "",
"gclid": "jdue47dj6ydhi3y83h",
"landing_page_url": "https://abcwindows.com/p/patiodoors.html?gclid=jdue47dj6ydhi3y83h",
"referrer_url": "https://www.google.com/",
"multisession_flag": false,
"page_variables": "{\"business_number\":12349876,\"listing_name\":\"ABC Comapany Inc.\"}",
"google_analytics": {
"client_id": "1850736795.1741268356",
"java_enabled": "false",
"google_session_id": "1741268356"
},
"adobe_analytics": {}
},
"routing_keypress": null,
"segment_name": null,
"start_time": "2025-02-26T16:42:11",
"answer_time": "2025-02-26T16:42:32",
"end_time": "2025-02-26T16:43:02",
"start_time_utc": "2025-02-26T21:42:10.522",
"answer_time_utc": "2025-02-26T21:42:32.378",
"end_time_utc": "2025-02-26T21:43:02.253",
"status": "processing",
"call_tags": null,
"rescue": {
"outcome": "N\\A",
"scorecards": []
},
"keyword_list": null,
"number_custom_fields": null,
"group_custom_fields": null,
"group_owner_custom_fields": null
}
]
}
{
"Id": "057f409d-6185-4898-bd1d-76a09c83ef02",
"Attempt": 1,
"Properties": {
"CollectionType": "CallDetailsV5",
"UTC": "2025-02-26T21:46:14.127",
"Organization": "5440",
"RequestId": "007ba9cf-5bc6-4552-90ab-69c2afe5332d"
},
"Notifications": [
{
"Action": "CallDetailsV5.CallProcessed",
"id": 2482086262,
"call_type_id": 1,
"call_type": "Standard",
"number_id": 13618259,
"group_id": 15117797,
"group_name": "ABC Windows and Doors - Google Ads",
"time_zone_id": 2,
"time_zone_name": "Eastern",
"group_owner_id": 7187041,
"study_name": "Google Ad",
"group_owner_name": "ABC Windows And Doors",
"billing_group_id": 56876,
"billing_group_name": "Level 2",
"number_pool_id": null,
"caller_identity": 474387804,
"organization_id": 5440,
"answer_status_id": 1,
"answer_status": "answered",
"ring_duration": 3,
"call_duration": 30,
"registered_DNC": false,
"tracking_number": "8332795145",
"caller_number": "9055802283",
"termination_number": "9056372483",
"caller_details": {
"name": "Ted Robertson",
"address": "2220 marine Drive",
"city": "Springfield",
"state": "IL",
"zip_code": "29293",
"country": "US",
"latitude": 43.4585,
"longitude": -79.6685
},
"conversation_analytics": {
"call_record_file": "cbe5a966-7837-4d0e-a3d5-df8e861e6cf6",
"call_record_redaction": false,
"voice_link": "https://webservice.telmetrics.com/filedownload.ashx/7f087a28-764d-4983-854d-0a9969feb3a3/2482086262.mp3",
"transcript": "Agent: To serve you better, this call may be recorded for training and quality purposes. Agent: [tone] Agent: [tone] Agent: [tone] Caller: ABC Windows and Doors. Agent: ABC Windows and Doors. Caller: Hi there. This is Joel calling. I was wondering if Sean was gonna come by today. He was scheduled to come by to give me a quote, and he didn't come Agent: Hi there. This is Joel calling. I was wondering if John was Agent: He was scheduled to come by to give me a quote, and he didn't come. Caller: oh, I'm sorry about that. Let me Agent: Oh, I'm sorry for that. Let Agent: me just Caller: just Caller: look at the scheduling here. Agent: look at the scheduling here. Caller: Yeah. No. He should have been there. Let me give him a call, and I'll get back to you. Agent: Yeah. No. He should have been there. Let me give him a call, and I'll get back to you. Caller: Okay. Thank you. Alright. Bye. Agent: Okay. Thank you. Alright. Bye. ",
"call_summary": "",
"sentiment_suite": null,
"dispositions": {
"lead": {
"status": false
},
"voicemail": {
"status": false
},
"current_customer": {
"status": false
},
"new_customer": {
"status": false
},
"employment_inquiry": {
"status": false
},
"conversation": {
"status": true
},
"opportunity": {
"status": false
},
"appointment": {
"status": false
},
"abandon": {
"status": false
},
"no_agent": {
"status": false
},
"no_caller": {
"status": false
},
"telemarketer": {
"status": false
},
"department": {
"status": "Undetermined"
}
},
"subresource_uris": null,
"industry": "Home Services",
"sub_industry": "Exterior",
"lead_outcome": {
"lead_reason": "Appointment - Confirming",
"lead": "false",
"appointment": "n/a",
"sales": "false" // only supported for Automotive Services
},
// depending on configured Industry Signal, values returned in lead_value will vary
//Home Services
"lead_value": {
"service_line": "n/a",
"product_or_service": [
"doors",
"windows"
],
"customer_type": "existing",
"maintenance_or_new_system": "n/a",
"age_over_10_years": "n/a"
},
//Dental
"lead_value": {
"insurance_discussed": "false",
"insurance_provider": "n/a",
"insurance_referral": "false",
"other_product_or_service": [
"n/a"
],
"customer_type": "new",
"product_or_service": [
"orthodontia"
]
},
//Automotive Services
"lead_value": {
"product_or_service": [
"Warranty"
],
"other_product_or_service": [
"N/A"
]
},
//Depending on configured Industry Signal, Topics returned in topics will vary
//Automotive Services
"topics": {
"pricing_discussed": "false",
"scheduling_discussed": "true",
"other_topics": []
},
//Dental
"topics": {
"pricing_discussed": "false",
"scheduling_discussed": "true",
"walk-in_discussed": "false",
"other_topics": []
},
//Home Services
"topics": {
"pricing_discussed": "false",
"scheduling_discussed": "true",
"other_topics": [
"hours or location"
]
}
},
"attribution_details": {
"session_identifier": "5aee13c2-1633-4ea6-bddb-145d355159df",
"session_id": "2386840770",
"rule_description": "Google Paid",
"rule_id": 464255,
"utm_source": "google",
"utm_medium": "search",
"gclid": "jdue47dj6ydhi3y83h",
"landing_page_url": "https://multisessiontester.blogspot.com/p/multisessiontracker.html?gclid=jdue47dj6ydhi3y83h",
"referrer_url": "https://www.google.com/",
"multisession_flag": false,
"page_variables": "{\"business_number\":12349876,\"listing_name\":\"ABC Comapany Inc.\"}",
"page_tracks": [
{
"page_url": "https://abcwindows.com/p/patiodoors.html?gclid=jdue47dj6ydhi3y83h",
"timestamp": "2025-03-06T13:39:16.827Z"
}
],
"google_analytics": {
"client_id": "1850736795.1741268356",
"java_enabled": "false",
"google_session_id": "1741268356"
}
},
"routing_keypress": null,
"segment_name": null,
"start_time": "2025-02-26T16:42:11",
"answer_time": "2025-02-26T16:42:32",
"end_time": "2025-02-26T16:43:02",
"start_time_utc": "2025-02-26T21:42:10.523",
"answer_time_utc": "2025-02-26T21:42:32.377",
"end_time_utc": "2025-02-26T21:43:02.253",
"status": "complete",
"call_tags": null,
"rescue": {
"outcome": "N\\A",
"scorecards": []
},
"keyword_list": [
{
"transcript_keyword_id": 682,
"name": "Windows",
"keywords_list": [
{
"keyword": "windows",
"agent": "00:00:13,48",
"caller": "00:00:13,45",
"agent_list": [
"00:00:13,48"
],
"caller_list": [
"00:00:13,45"
]
},
{
"keyword": "doors",
"agent": "00:00:13,48",
"caller": "00:00:13,45",
"agent_list": [
"00:00:13,48"
],
"caller_list": [
"00:00:13,45"
]
},
{
"keyword": "patio",
"agent": "00:01:05,83",
"caller": "00:00:23,96|00:01:05,73",
"agent_list": [
"00:01:05,83"
],
"caller_list": [
"00:00:23,96",
"00:01:05,73"
]
}
]
}
],
"number_custom_fields": null,
"group_custom_fields": null,
"group_owner_custom_fields": null
}
]
}
{
"Id": "057f409d-6185-4898-bd1d-76a09c83ef02",
"Attempt": 1,
"Properties": {
"CollectionType": "CallDetailsV5",
"UTC": "2025-03-04T13:46:02.600",
"Organization": "5440",
"RequestId": "fb918241-47ab-4e8f-9d97-452c85bcb1b5"
},
"Notifications": [
{
"Action": "CallDetailsV5.CallStartCall",
"id": null,
"call_type_id": 1,
"call_type": "Standard",
"group_id": 15117797,
"group_name": "ABC Windows and Doors - Google Ads",
"time_zone_id": 2,
"time_zone_name": "Eastern",
"group_owner_id": 7187041,
"number_id": 13618259,
"study_name": "Google Ad",
"group_owner_name": "ABC Windows And Doors",
"billing_group_id": 56876,
"billing_group_name": "Level 2",
"number_pool_id": null,
"caller_identity": 474387804,
"organization_id": 5440,
"answer_status_id": null,
"answer_status": null,
"ring_duration": null,
"call_duration": null,
"registered_DNC": null,
"tracking_number": "8332795145",
"caller_number": "9055802283",
"termination_number": null,
"caller_details": {
"name": "Ted Robertson",
"address": "2220 marine Drive",
"city": "Springfield",
"state": "IL",
"zip_code": "29293",
"country": "US",
"latitude": 43.4585,
"longitude": -79.6685
},
"conversation_analytics": null,
"attribution_details": {
"utm_source": "",
"utm_medium": "",
"landing_page_url": "",
"referrer_url": "",
"multisession_flag": false
},
"routing_keypress": null,
"segment_name": null,
"start_time": "2025-03-04T13:45:59.619",
"answer_time": null,
"end_time": null,
"start_time_utc": null,
"answer_time_utc": null,
"end_time_utc": null,
"status": "processing",
"call_tags": null,
"rescue": null,
"keyword_list": null,
"number_custom_fields": null,
"group_custom_fields": null,
"group_owner_custom_fields": null
}
]
}
Updated about 1 month ago