# Webhook Diversions List

Retreaver has a list of supported integrations that are not templated under the Retreaver webhook configurator ( which typically handle URL parameter and JSON workflows ). 

For API's built with unconventional response formats such as pipe delimited content or XML (Extensible Markup Language), Retreaver diverted these workflows away from the webhook configurator tool and instead are using an internal webhook request and response handler. 

A list of these webhooks have been documented below for use by the Retreaver support team or any Retreaver clients looking to implement these integrations unto their call campaigns. 

 

Note: Do not utilize the webhook configurator for any diverted integration URL's, otherwise instead of internally diverting the URL, the system will try to communicate with a non-reachable API endpoint and the integration will not process correctly.

Additional Note: Certain API platforms may require you to whitelist Retreaver IP addresses in order to respond. 

 

Generic XML Webhook Configurator Diversion

Generic XML Webhook Format:

https://retreaver.com/webhook-integration/xml/?output_tag_prefix=example_12345&xml_method=POST&xml_url=https://example-xml-api.com/integration&xml_headers=%7B%22Content-Type%22:%22application/xml%22%7D&xml_body=%3Ccontact_create%3E%3Caccess_key%3El86t6wyppm%3C/access_key%3E%3C/contact_create%3E&xml_output_map=%7B%22number%22:%22//response/@number%22,%22bid%22:%22//response/@bid%22,%22timer%22:%22//response/@timer%22%7D

Generic XML Setup Instructions:

1) Create the webhook and set it to trigger on your desired circumstance, typically "Passthrough" or "On Call start".

2) Replace the following URL parameters with your required values: 

output_tag_prefix, xml_method, xml_url, xml_headers, xml_body & xml_output_map. 


Critical note: You must URI encode the JSON and XML values entered in these fields otherwise the internal parser will not be able to convert the URL into proper JSON or XML format.

Most common encoded characters include:

" becomes %22 
{ becomes %7B
} becomes %7D
< becomes %3C
> becomes %3E

3) Update the buyer  tags, typically including a transfer number with [example_12345_number] and utilize any conversion tokens such as 'example_12345_timer' & 'example_12345_timer on your conversion criteria.

 

 

Vicidial Pipe-Delimited Agent Availability Diversion

Vicidial Webhook Format:

https://retreaver.com/webhook-integration/vicidial-availability/?call_key=[call_key]&call_uuid=[call_uuid]&tag_name_prefix=vicidial_agents_waiting_12345&delimiter_index=13&caller_number=[nanp_caller_number]&url=https://ppg.phdialer.com/vicidial/non_agent_api.php?source=template%26user=template%26pass=template%26stage=http%26function=in_group_status%26in_groups=template%26header=YES

Vicidial Setup Instructions:

1) Create the webhook and set it to trigger on "Passthrough" or "On Call start".

2) Replace fields highlighted in green.

3) Tag the buyer with "vicidial_agents_waiting_12345" >= 1.

4) (Optional ) If the Vicidial integration returns the pipe delimited availability value in another index, you may need to adjust the 'delimiter_index' parameter value from the default '13' to another value. 

 

 

Five9 XML Agent Availability Diversion

Five9 Webhook Format:

https://retreaver.com/webhook-integration/five9-xml-agent-availabilty/?call_key=[call_key]&call_uuid=[call_uuid]&encoded_authorization_token=AUTH-TOKEN&output_tag_prefix=five9_12345&statistic_type=ACDStatus&column_name=Agents%20Ready%20For%20Calls&row_response=[caller_state]%20Skill

Five9 Setup Instructions:

1) Create the webhook and set it to trigger on "Passthrough" or "On Call start".

2) Replace fields highlighted in green.

3) Tag the buyer with "five9_12345_get_stat_response" >= 1.

 

 

Networx XML Ping Diversion

Networx Webhook Format:

https://retreaver.com/webhook-integration/networx-xml-ping/?call_key=[call_key]&call_uuid=[call_uuid]&nx_userId=55555&nx_access_key=template&network_id=template&zipcode=[caller_zip]&phone=[nanp_caller_number]&output_tag_prefix=networx_12345&task_id=299

Networx Setup Instructions:

1) Create the webhook and set it to trigger on "Passthrough" or "On Call start".

2) Replace fields highlighted in green.

3) Update the buyer transfer number with [networx_12345_number] and utilize the conversion token 'networx_12345_timer' & 'networx_12345_bid on your conversion criteria.

 

 

Datalot Medicare XML Ping Diversion

Datalot Medicare Webhook Format:

https://retreaver.com/webhook-integration/datalot-xml-medicare/?call_key=[call_key]&call_uuid=[call_uuid]&caller_number=[nanp_caller_number]&city=[caller_city]&state=[caller_state]&zip=[caller_state]&age=77&test=false&access_key=ACCESS_KEY&source_id=SOURCE_ID&product_id=227&campaign_id=CAMPAIGN_ID&output_tag_prefix=datalot_medicare_12345&dob_year=1950&dob_month=01&dob_day=01

Datalot Medicare Setup Instructions:

1) Create the webhook and set it to trigger on "Passthrough" or "On Call start".

2) Replace fields highlighted in green. If possible, change the values in yellow if you are collecting those fields - otherwise note that we've hardcoded those values to a default format that the integration requires and accepts.

3) Update the buyer and utilize the revenue conversion token 'datalot_medicare_12345_ping_price' on your conversion criteria.

4) Tag the buyer with 'datalot_medicare_12345_success' == 'true'.

 

 

Datalot Health XML Ping Diversion

Datalot Health Webhook Format:

https://retreaver.com/webhook-integration/datalot-xml-health/?call_key=[call_key]&call_uuid=[call_uuid]&caller_number=[nanp_caller_number]&city=[caller_city]&state=[caller_state]&zip=[caller_state]&age=77&test=false&access_key=ACCESS_KEY&source_id=SOURCE_ID&product_id=227&campaign_id=CAMPAIGN_ID&output_tag_prefix=datalot_health_12345&dob_year=1950&dob_month=01&dob_day=01

Datalot Health Setup Instructions:

1) Create the webhook and set it to trigger on "Passthrough" or "On Call start".

2) Replace fields highlighted in green. If possible, change the values in yellow if you are collecting those fields - otherwise note that we've hardcoded those values to a default format that the integration requires and accepts.

3) Update the buyer and utilize the revenue conversion token 'datalot_health_12345_ping_price' on your conversion criteria.

4) Tag the buyer with 'datalot_health_12345_success' == 'true'.

 

 

Datalot Auto XML Ping Diversion

Datalot Auto Webhook Format:

https://retreaver.com/webhook-integration/datalot-xml-auto/?call_key=[call_key]&call_uuid=[call_uuid]&caller_number=[nanp_caller_number]&city=[caller_city]&state=[caller_state]&zip=[caller_state]&age=77&test=false&access_key=ACCESS_KEY&source_id=SOURCE_ID&product_id=227&campaign_id=CAMPAIGN_ID&output_tag_prefix=datalot_auto_12345&dob_year=1950&dob_month=01&dob_day=01&email=example_email@gmail.com&first_name=john&last_name=doe&annual_miles=5000&company=progressive&started=2015-07-15&expires=2020-07-29&continuous_years_insured=5&license_issued=2000-12-31

Datalot Auto Setup Instructions:

1) Create the webhook and set it to trigger on "Passthrough" or "On Call start".

2) Replace fields highlighted in green. If possible, change the values in yellow if you are collecting those fields - otherwise note that we've hardcoded those values to a default format that the integration requires and accepts.

3) Update the buyer and utilize the revenue conversion token 'datalot_auto_12345_ping_price' on your conversion criteria.

4) Tag the buyer with 'datalot_auto_12345_success' == 'true'.