About Post-to-URL in integrations
Articles related to customization are written for a technical audience who have experience in web development. Knowledge of HTML, CSS, and JavaScript are required.
The Post to URL function is used in conjunction with CRM Integration APIs (particularly requestPINCode) to provide a complete set of integration tools for CRMs or other applications.
Post to URL allows you to host your own server script to handle the Rescue session data and to process them as you see fit. Some potential use examples include database importing and email notifications.
How it Works
- The Rescue technician starts a support session
- At the beginning and/or end of a session, the session data are transferred via HTTP Post or XML to the specified URL
- Your script processes the data as specified in your code
Post-to-URL Variables
These are the variables that are submitted via the Post to URL function.
[...] is replaced with the actual data value. This method does an XML request to your URL. You would handle this via an XML parser.
| Rescue Session Data | Description |
|---|---|
| <sessionid>[...]</sessionid> | Rescue Session ID |
| <techid>[...]</techid> | Technician ID |
| <techssoid>[...]</techssoid> | Technician Single Sign-on ID (as defined on the Organization tab in the Administration Center) |
| <techname>[...]</techname> | Technician name (as defined on the Organization tab) |
| <techemail>[...]</techemail> | Technician email (as defined on the Organization tab) |
| <techdescr>[...]</techdescr> | Technician description (as defined on the Organization tab) |
| <cfield0>[...]</cfield0> | Value returned for the Name field (as defined on the Global Settings tab in the Administration Center) |
| <cfield1>[...]</cfield1> | Value returned for Custom field 1 (as defined on the Global Settings tab) |
| <cfield2>[...]</cfield2> | Value returned for Custom field 2 (as defined on the Global Settings tab) |
| <cfield3>[...]</cfield3> | Value returned for Custom field 3 (as defined on the Global Settings tab) |
| <cfield4>[...]</cfield4> | Value returned for Custom field 4 (as defined on the Global Settings tab) |
| <cfield5>[...]</cfield5> | Value returned for Custom field 5 (as defined on the Global Settings tab) |
| <tracking0>[...]</tracking0> | Value returned for the Tracking field; typically used for mapping Rescue sessions to a CRM |
| <chatlog>[...]</chatlog> | Transcript of all chat held since the previous post |
| <notes>[...]</notes> | Notes saved by the technician |
| <waitingtime>[...]</waitingtime> | From the beginning of Waiting status until session start (Active status) in seconds |
| <pickuptime>[...]</pickuptime> | The exact time when the session entered Active status (UTC) |
| <closingtime>[...]</closingtime> | The exact time when the session entered Closed or Timed Out status (UTC) |
| <worktime>[...]</worktime> | Actual Technician Console utilization time during the session (until the post) in seconds |
| <lastactiontime>[...]</lastactiontime> | The exact time of the last action taken by the technician in the Technician Console (UTC) |
| <transmitted>[...]</transmitted> | Amount of data transmitted during the session (until the post) in bytes |
| <platform>[...]</platform> | The platform of the customer device |
| <tsurvey0>[...]</tsurvey0> | Value returned for Technician Survey Question 1 (as defined on the Settings tab) |
| <tsurvey1>[...]</tsurvey1> | Value returned for Technician Survey Question 2 |
| <tsurvey2>[...]</tsurvey2> | Value returned for Technician Survey Question 3 |
| <tsurvey3>[...]</tsurvey3> | Value returned for Technician Survey Question 4 |
| <tsurvey4>[...]</tsurvey4> | Value returned for Technician Survey Question 5 |
| <tsurvey5>[...]</tsurvey5> | Value returned for Technician Survey Question 6 |
| <tsurvey6>[...]</tsurvey6> | Value returned for Technician Survey Question 7 |
| <tsurvey7>[...]</tsurvey7> | Value returned for Technician Survey Question 8 |
| <tsurvey8>[...]</tsurvey8> | Value returned for Technician Survey Question 9 |
| <tsurvey9>[...]</tsurvey9> | Value returned for Technician Survey Question 10 |
HTTP Post based
This method submits the URL with the POST variables on the end. This is the same as submitting an HTML form. The variables use the same naming convention as the XML format.
https://example.com/script.aspx]?SessionID=[...]&TechID=[...]&TechSSOID=[...]
&TechDescr=[...]&CField0=[...]&CField1=[...]&CField2=[...]&CField3=[...]
&CField4=[...]&CField5=[...]&Tracking0=[...]&ChatLog=[...]&
Notes=[...]&WaitingTime=[...]&PickupTime=[...]&ClosingTime=[...]&
WorkTime=[...]&LastActionTime=[...]&Transmitted=[...]&TSurvey0=[...]&
TSurvey1=[...]&TSurvey2=[...]&TSurvey3=[...]&TSurvey4=[...]&TSurvey5=[...]&
TSurvey6=[...]&TSurvey7=[...]&TSurvey8=[...]&TSurvey9=[...]
Note: The HTTP POST option is actual POST data. Using the GET method will not work properly.
Article last updated: 26 March, 2024