# Webhook ### SETUP Under ‘Edit’ in **Manage Location**, Click on the **Webhook Management** tab. A list of all current webhooks for that location will appear. You can edit or add new webhooks. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2Fvu33bZHErKVov6Jk6l8g%2FScreen%20Shot%202022-05-10%20at%2010.26.16%20AM.png?alt=media\&token=7a5f718c-a5da-45ae-9cc3-54bfc745b936) ### Add a Webhook Click on the blue ‘Add Webhook’ button in the top right corner ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FP3Ujxa01tfgCYp0wcc3T%2Fimage.png?alt=media\&token=151b010c-e495-4749-8c5a-97a69742a16e) A user can choose: * **Existing Templates**: Create a new webhook with a template that’s already made * **Create Template**: Create a new template along with the webhook ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FJlqYtS58eu38IF8oZvAn%2Fimage.png?alt=media\&token=c470137e-74bb-4472-9782-411fe9969e3e) ### Select From Existing Template #### STEP 1: Basic Settings ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FBAPBP8KqpNn1jWXf4y18%2Fimage.png?alt=media\&token=102989eb-55d4-4afa-9eb5-27468d490da2) * **Webhook Name:** What you would like the webhook to be called * **URL:** The endpoint the events will be sent to * **Template:** What template you want to use. A list of templates available to your group will be listed here. Click **Next** to go to the next step. #### STEP 2: Advanced Settings If you have a more advanced setup, you can add those details here ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FI5r9VpI11igmPShGUSmG%2Fimage.png?alt=media\&token=edc2b2c6-b43e-4be6-9145-63ddb239c5af) * **HTTP Header:** Select what HTTP Header is needed (you can add more than 1 by clicking the “+” icon * **Value:** enter in your header value, for example: application/xml, or application/json * **Success response code:** Select your success return response (examples 200, 201, 202, 203, 204) * **HTTP Method:** Choose either POST or PUT #### STEP 3: Summary A summary will show your selections. If everything is correct, select ‘Finish’ to save your webhook. The webhook will now appear in the available drop-down list where applicable ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FtpAdeD8Ow6Z36QpOmhA5%2Fimage.png?alt=media\&token=76f222d4-2fc6-45b0-8461-227cad6e844b) ### Create Template The second option is to click on “Create Template” on the main screen. Once you click on “Create Template”, a list of new options will appear. This option is used if the template you want to use doesn’t already exist and needs to be created from scratch. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FJRKtZViLownrplauyVfz%2F7?alt=media) #### STEP 1: Basic Settings ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2Flc4WCIJoAYeXdSM5daXK%2Fimage.png?alt=media\&token=6d4eb641-4dab-47b1-b66b-8546f17f2491) * **Webhook Name:** What you would like the webhook to be called * **URL:** The endpoint the events will be sent to * **Template:** What template you want to use * **Template Name:** The name of your custom template * **Template Group**: What Group you would like to assign the template to (who else can use it) * **Template Type**: What type of template are you making (JSON or XML are current options) * **Template Format:** Enter in the format of your template. This must be in the correct format, or you will receive an error and cannot move to the next screen. The example below shows JSON Format with the fields: Firstname, Lastname, email Once all the fields have been added, click Next to go to the next step. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FH6uN6y2CuybGG7Lrl9c7%2Fimage.png?alt=media\&token=1e8a08a5-0638-4f1e-be3d-931b17b2eb46) #### STEP 2: Custom Data Once you provide your template example, the fields will be extracted so you can correlate the AutoID data point to the correct field. The field in the drop-down is the data point that will be entered into the template when data is sent. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FRgcNAgQXpXcu7grQbmkS%2Fimage.png?alt=media\&token=0eec1fe9-3edc-464b-9823-11d0eeefc489) Clicking on the drop-down fields will bring up the full list of possible tokens that can be used for each extracted data point. Select the data point that best fits what data you want to go into that field when a webhook is sent. The data points are organized into different categories to make it easier to find what you are looking for. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2F3okTJE03zTWmi2uyjvZ8%2Fimage.png?alt=media\&token=f505864d-9785-4ce2-b3e4-f07b64276f2a) In the example below, I selected First Name for “first”, Last Name for “last”, and ANI for “phone”. When the webhook is sent, the first field will show the caller’s first name, the last field will show the caller’s last name, and the phone field will show the number of the person who called the location. Click **Next** to Get to Advanced Settings. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FZ7UGO4n6hndzAkhFDO7V%2Fimage.png?alt=media\&token=02ada0eb-0d9d-43a6-a4ac-1eb153f47648) #### STEP 3: Advanced Settings If you have a more advanced setup, you can add those details here * **HTTP Header**: Select what HTTP Header is needed (you can add more than 1 by clicking the “+” icon) * **Value:** enter in your header value, for example application/xml, or application/json * **Success response code**: Select your success return response (examples 200, 201, 202, 203, 204) * **HTTP Method**: Choose either POST or PUT Click **Next** to go to the Summary. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2Fo2ZA2TsUZOafLwNvVvHt%2Fimage.png?alt=media\&token=cdfd9542-471e-4220-88e9-7077117149d7) #### #### STEP 4: Summary A summary will show your selections. If everything is correct, select ‘Finish’ to save your webhook. The webhook will now appear in the available drop-down list where applicable ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FyPY25BGkZoqTqo4ZQoDe%2Fimage.png?alt=media\&token=b1880d47-c030-40de-9fbc-12bb88edf4e9) ### WEBHOOK ENABLING Once a webhook template has been created, you can enable webhooks at different areas of the system. The main places you can enable webhooks are: #### **Call Treatments:** For each treatment you create, you can enable a webhook to be sent. This allows for customization in what calls get sent into the third-party system or CRM. See [*Call Treatments*](https://support.autoid.com/docs/call-treatments#_call_treatment_webhook) for more info. * Example: An IVR call treatment is set up to have Sales, Service, Parts. Webhooks are set up on the ‘Sales’ extension so only callers who push ‘Sales’ will have calls sent to the CRM. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FwIXM4mH9eH3N4xFLhJ3z%2Fimage.png?alt=media\&token=75046189-8406-4741-966f-a3274f441e1c) #### Static Campaigns: For each campaign you create, you can enable a webhook to be sent. This can be done either by adding a new campaign or editing an existing campaign. See [*Offline Marketing Campaigns* ](https://support.autoid.com/docs/location-management/offline-marketing-campaigns)for more info. * Click the Webhook Dropdown to select the webhook that was created. * Designate if the webhook will be sent at the beginning of the call or end of the call. ![](https://2509010157-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fd4GRlhSJjbB4yPjM459z%2Fuploads%2FP0jRfs31RpkPx2GYdeGL%2Fimage.png?alt=media\&token=96a24393-acd8-433d-8cb5-dd832ed38872) #### DNI Campaigns: For each DNI campaign, you create, you can enable a webhook to be sent. This can be done either by adding a new campaign or editing an existing one. See [*Digital Campaigns*](https://support.autoid.com/docs/location-management/digital-campaigns) for more info. * Click the Webhook Dropdown to select the webhook that was created. * Designate if the webhook will be sent at the beginning of the call or end of the call.
### WEBHOOK OUTPUT Once a webhook template has been set up and added to a campaign(s), webhooks will be sent to the endpoint specified: **Endpoint:** *http(s)://\/\)* **Header Type:** *application/json* or *application/xml* **Body Definitions:**
Token NameCategoryDescriptionExample
%callid%call_beginCallID - Unique Identifier of call093cc03c.e6a4.6ac6.978f.740b10afeaca
%session_id%call_beginSession ID - ID for the users session5da13c4f-753f-448a-81a1-12456785be20
%dialed_time%call_endDialed Time - Full Duration including dial time36
%answered_time%call_endAnswered Time - Duration of connection time29
%dialstatus%call_endDialStatus - Did remote party answer or notANSWER
%tracking%call_beginTracking - The Tracking number dialed7774839229
%ani%call_beginANI - Telephone number of person calling7776734736
%call_start_time%call_beginCall Start Time - The start time of call (Default: 24 hour GMT)2019-03-28T00:05:00.000Z
%call_end_time%call_endCall End Time - The end time of call (Default: 24 hour GMT)2019-03-28T00:05:30.000Z
%target%dniTarget - The target destination7776734700
%global_id%dniGlobal ID - Unique user identification0f9cec2d1236e1234d8e123a7adff123
%landing_domain%dniLanding Domain - Domain Name of website consumer landed onexample.com
%repeat_caller%call_beginRepeat Caller - 1 or 01 (repeat caller)
%prompt_responses%call_endTreatment Response - Call Treatment Flow of consumer (Nested object)
%question%call_endQuestion Nameone
%question_link%call_endLink to audio filehttp://app.example.com/prompts-qa/audio/-1/94f17d142e0e861bfa34.wav
%response%call_endWhat the caller pressed1
%domain_name%dniDomain Name - Domain Name where DNI is installedexample.com
%campaign_name%call_beginCampaign Name - Campaign NameSales Campaign
%rec_audiourl%call_endAudio URL - Audio Recording in MONO MP3 Formathttps://audio.example.com/MP3/202110/demo.e123.4d3c.41de.123468.mp3
%rec_audiowavurl%call_endAudio URL - Audio Recording in Stereo WAV Formathttps://audio.example.com/MP3/202110/demo.e123.4d3c.41de.123468.wav
%ani_is_valid%call_beginIs Valid - 1 or 01 meaning it is a valid ANI
%ani_line_type%call_beginLine Type - Caller\s line typeMobile/NonFixedVOIP/Landline/TollFree/FixedVOIP
%ani_carrier%call_beginCarrier - Caller\s CarrierATT/Verizon Wireless/T-Mobile USA
%ani_full_name%call_beginFull Name - Caller\s Full NameFreddy Krueger
%ani_first_name%call_beginFirst Name - Caller\s First NameFreddy
%ani_middle_name%call_beginMiddle Name - Caller\s Middle NameCharles
%ani_last_name%call_beginLast Name - Caller\s Last NameKrueger
%ani_type%call_beginType - Caller\s Home Type - (Single Family or Multi Family)Charles
%ani_street_line_1%call_beginStreet Line 1 - Caller\s Address Line 11428 Elm Street
%ani_street_line_2%call_beginStreet Line 2 - Caller\s Address Line 2Apt 2
%ani_city%call_beginCity - Callers City NameSpringwood
%ani_zip%call_beginZIP - Callers Zip Code50035
%ani_zip4%call_beginZIP4 - Callers Zip plus 4"1001
%ani_state%call_beginState - Callers State NameOhio
%ani_country_code%call_beginCountry Code - Caller Country CodeUS
%ani_street_number%call_beginStreet Number - Caller Street Number1428
%ani_street_name%call_beginStreet Name - Caller Street NameElm
%ani_street_type%call_beginStreet Type - Caller Street TypeSt
%ani_updated_at%call_beginUpdated At - Caller Information last lookup data13 Oct 2020 3:15:12 PM
%tags%call_beginTags - Data used to identify and group campaigns (Nested object)Region: south
%location_name%location_infoLocation - NameAuto ID
%location_address_line_1%location_infoLocation - Address Line 1157 Main Street
%location_address_line_2%location_infoLocation - Address Line 2Apt 4
%location_address_city%location_infoLocation - CityLos Angeles
%location_address_zip%location_infoLocation - Zip91741
%location_address_state%location_infoLocation - StateCA
%account_id%location_infoAccount ID - Client\s provided account number26627332
%location_id%location_infoLocation ID - Client\s provided location ID3242243
%page_id%dniUnique ID of the Web Pagee14eb2bb-b829-4d19-bf5a-da76ccffbf4e
%page_converted_on%dniPage Converted On - The page that your customer made the callhttps://www.example.com/about_us.htm
%first_page_landed_on%dniFirst Page Landed On - The page that your customer first landed on your sitehttps://www.example.com
%vehicle_vin%dniVehicle Identifier1C6RRFFG9KN909808
%vehicle_year%dniVehicle Year2019
%vehicle_make%dniVehicle MakeRam
%vehicle_model%dniVehicle Model1500
%referral_domain%dniReferral Domain - Domain user was referred fromfacebook.com
%medium%dniMedium Type - Paid|Organic|Direct|Referral|OtherPaid
%utm_source%dniUTM Source - Identifies source of trafficfacebook
%utm_medium%dniUTM Medium - Specifies the mediumlike social or newsletter
%utm_campaign%dniUTM Campaign - Identifies the campaign the URL is part ofsales
%utm_content%dniUTM Content - Content user is directed to123
%keyword%dniKeyword - Trackingair conditioning
%gclid%dniGCLID - Google Click IDxyz123
%ring_count%call_endRing Count - Count of Rings before Answer4
%site_id%location_infoAutoIDs Site Identifier4567
%domain_id%location_infoAutoIDs Location Identifier1234
%visitor_browser_family%dniVisitors - Browser FamilyFirefox
%visitor_browser_version%dniVisitors - Browser Version79
%visitor_device%dniVisitors - DeviceOther
%visitor_country_code%dniVisitors - Country CodeUS
%visitor_region%dniVisitors - RegionCA
%visitor_city%dniVisitors - CityLos Angeles
%visitor_ip_address%dniVisitors - IP Address47.156.108.175
%visitor_operating_system%dniVisitors - Operating SystemMac OS X
%visitor_lat%dniVisitors - Latitude34.153500
%visitor_long%dniVisitors - Longitude-117.845700
#### Example JSON Output: ``` { "callid": "093cc03c.e6a4.6ac6.978f.740b10afeaca", "session_id": "5da13c4f-753f-448a-81a1-290bb7e5be20", "dialed_time": "36", "answered_time": "29", "dialstatus": "ANSWER", "tracking": "7774839229", "ani": "7776734736", "call_start_time": "2019-03-28T00:05:00.000Z", "call_end_time": "2019-03-28T00:05:30.000Z", "target": "7776734700", "global_id": "0f9cec2d7556e9011d8e102a7adff138", "landing_domain": "example.com", "repeat_caller": "1 meaning it is a repeat caller", "prompt_responses": [ { "question": "one", "question_link": "http://app.example.com/prompts-qa/audio/-1/94f17d142e0e861bfa34.wav", "response": "1" } ], "domain_name": "example.com", "campaign_name": "Sales Campaign", "rec_audiourl": "https://audio.example.com/MP3/202110/demo.e354.4d3c.41de.00f56e4c7078.mp3", "rec_audiowavurl": "https://audio.example.com/MP3/202110/demo.e354.4d3c.41de.00f56e4c7078.wav", "ani_is_valid": "1 meaning it is a valid ANI", "ani_line_type": "Mobile/NonFixedVOIP/Landline/TollFree/FixedVOIP", "ani_carrier": "ATT/Verizon Wireless/T-Mobile USA", "ani_full_name": "Freddy Krueger", "ani_first_name": "Freddy", "ani_middle_name": "Charles", "ani_last_name": "Krueger", "ani_type": "Charles", "ani_street_line_1": "1428 Elm Street", "ani_street_line_2": "Apt 2", "ani_city": "Springwood", "ani_zip": "50035", "ani_zip4": "1001", "ani_state": "Ohio", "ani_country_code": "US", "ani_street_number": "1428", "ani_street_name": "Elm", "ani_street_type": "St", "ani_updated_at": "13 Oct 2020 3:15:12 PM", "tags": { "Region": "south", "Product": "12345" }, "location_name": "Auto ID", "location_address_line_1": "157 Main Street", "location_address_line_2": "Apt 4", "location_address_city": "Los Angeles", "location_address_zip": "91741", "location_address_state": "CA", "account_id": "26627332", "location_id": "3242243", "page_id": "e14eb2bb-b829-4d19-bf5a-da76ccffbf4e", "page_converted_on": "https://www.example.com/about_us.htm", "first_page_landed_on": "https://www.example.com", "vehicle_vin": "1C6RRFFG9KN909808", "vehicle_year": "2019", "vehicle_make": "Ram", "vehicle_model": "1500", "referral_domain": "facebook.com", "medium": "Paid", "utm_source": "facebook", "utm_medium": "like social or newsletter", "utm_campaign": "sales", "utm_content": "123", "keyword": "air conditioning", "gclid": "xyz123", "ring_count": "4", "site_id": "4567", "domain_id": "1234", "visitor_browser_family": "Firefox", "visitor_browser_version": "79", "visitor_device": "Other", "visitor_country_code": "US", "visitor_region": "CA", "visitor_city": "Los Angeles", "visitor_ip_address": "47.156.108.175", "visitor_operating_system": "Mac OS X", "visitor_lat": "34.153500", "visitor_long": "-117.845700" } ``` #### Supported Error Messages: | **200 OK** | Successful (Also can support 201, 202, 203, 204) | | ------------------ | ------------------------------------------------ | | **Ring to Number** | Error for retransmission once you’re back online |