Voice Webhooks

Voice webhooks allow you to receive HTTP callbacks at user-defined URIs when call events occur.

You can receive webhooks using GET or POST.

Events

The following events are supported.

Event NameDescription
Call.InitiateFired at the start of a phone call.
Call.CompleteFired at the end of a phone call.

Parameters

Common Parameters

The following parameters are present in every request.

ParameterTypeDescriptionCall.InitiateCall.Complete
ActionstringValue will be: WebhookXX
EventstringThe name of the event as per the event table.XX
Account.SidstringThe secure identifier of the applicable account.XX
Property.SidstringThe secure identifier of the applicable property.XX
Property.NamestringThe name of the property. For website properties, this will be the domain name.XX
Property.TypestringThe type of property this represents. The value currently can only be SiteXX

Call Parameters

The following parameters are present in every phone call related request.

ParameterTypeDescriptionCall.InitiateCall.Complete
Call.SidstringThe secure identifier of the call.XX
Call.StartDatestringThe date and time of the call in UTC and formatted as yyyy-MM-dd HH:mm:ss.XX
Call.FromstringThe caller ID of the caller in E164 (international) format. Can be anonymous if the caller ID is unavailable.XX
Call.From.CountrystringThe country where the call originated. Will be blank if unknown.XX
Call.From.RegionstringThe region/state where the call originated. Will be blank if unknown or not applicable.XX
Call.From.CitystringThe city where the call originated. Will be blank if unknown.XX
Call.TostringThe phone number that was dialled in E164 (international) format.XX
Call.To.TypestringThe type of phone number that was dialled. Can either be Static or Dynamic-X
Call.To.NamestringThe name of the phone number as configured in the account.XX
Call.DurationintegerThe duration of the call in seconds.-X
Call.DispositionstringThe outcome of the call.-X
Call.Recording.UristringOptional. The URI of the call recording.-X
Call.EndpointstringOptional. The endpoint phone number where the call was transferred in E164 (international) format.XX
Call.Survey.TypestringOptional. The call type selected in the agent survey.-X
Call.Survey.ValueintegerOptional. The value entered in the agent survey.-X
Call.Survey.Custom1stringOptional. The selection in the agent survey mapped to custom field 1.-X
Call.Survey.Custom2stringOptional. The selection in the agent survey mapped to custom field 2.-X
Call.Survey.Custom3stringOptional. The selection in the agent survey mapped to custom field 3.-X
Call.Survey.UniqueCodestringOptional. The unique code played in the agent survey.-X
Call.Prompts.PostcodestringOptional. A comma-delimited list of postcodes that were entered in the call.-X
Call.Prompts.KeysstringOptional. A comma-delimited list of keys that were entered in the call, including any postcodes.-X

Attribution Parameters

The following parameters are present in every request where attribution information is expected.

ParameterTypeDescriptionCall.InitiateCall.Complete
Attribution.SourcestringThe "source" attribution parameter. e.g. "bing"XX
Attribution.MediumstringThe "medium" attribution parameter. e.g. "organic"XX
Attribution.CampaignstringThe "campaign" attribution parameter. e.g. "2019 promo"XX
Attribution.ContentstringThe "content" attribution parameter. e.g. "variation 1"XX

Session Parameters

The following parameters are present in every web-session related request.

ParameterTypeDescriptionCall.InitiateCall.Complete
Session.Traffic.TypestringThe traffic type. Can be: Campaign, Direct, Organic, Referral, or Unattributed.XX
Session.KeywordsstringOptional. The search keywords.XX
Session.ConversionUristringThe URI of the page where the event occurred.XX
Session.LandingUristringThe URI of the landing page.XX
AnalyticsSession.CustomDimension1stringOptional.XX
AnalyticsSession.CustomDimension1stringOptional.XX

Integration Parameters

The following parameters are present depending on the status and type of integration.

ParameterTypeDescriptionCall.InitiateCall.Complete
Google.Analytics.ClientIdstringOptional. The Google Analytics Universal Client ID. This can be used to push events into Google Analytics Universal.XX
Google.AdWords.ClickIdstringOptional. The Google AdWords Click ID. Also known as the GCLID.XX

Call Dispositions

The call disposition will have one of the following values.

ValueDescription
ANSWEREDThe call was transferred to an endpoint which answered.
NO ANSWERThe call attempted a transfer to an endpoint but it did not answer.
BUSYThe call attempted a transfer to an endpoint but the endpoint reported busy.
IVRThe call did not attempt a transfer to an endpoint. This can happen when a caller hangs up during an IVR prompt or before the initiation of a transfer.
FAILEDSomething went wrong with the call or the endpoint.