Overview
This article will discuss how to configure Convoso Connect for GET Requests.
- This feature uses API to integrate lead information in our system to other third-party systems.
- This is commonly used by Admins who want to push information from their third-party CRM to Convoso.
Contents
Configuring Convoso Connect for a GET Request
1.) Click the Apps main menu.
2.) Click the Convoso Connect menu option.
The Show Convoso Connect page will open.
3.) Locate the Convoso Connect you want to edit in the Table.
4.) Click the gear wheel drop-down in the Action column.
5.) Select the Settings option.
The View Convoso Connect page will open on the General tab.
6.) Edit the necessary information about the Vendor.
-
(A) Name –
Vendor name is used for reference only and can be modified. -
(B) API URL –
Enter the API URL of the Vendor. -
(C) Api Authentication –
If the Vendor is using an Auth Token, put that in this section. -
(D) Authorization Header -
(ex: Content-length: 0|Content-type: application/json|Authorization: OAuthSomeOAuthaccess_tokenString) -
(E) Request Method –
- GET – API Vendor will be posting lead into the system.
-
(F) Response Data Type –
Select the Data Type that is compatible with the third-party API.
- JSON - (ex: {key1:[value1,value2,value3],key2:[value1,value2,value3]})
- XML - (ex: <Values><value>value1</value><value>value2</value></Values>)
- TEXT - (ex: value1,value2,value)
-
(J) Adaptor ID –
If the Request Method is POST, we need to select the Adaptor ID assigned to the Vendor.- For more about Adaptors, see Adding, Editing, and Deleting Adaptors.
7.) Click on Save Convoso Connect button at the bottom of the Convoso Connect General Settings section.
8.) To test the settings, scroll down to the Test Convoso Connect section.
9.) Click the Test Convoso Connect button.
- A message that says: "Check result on the Convoso Connect Logs tab" will appear.
10.) Scroll up, and click the Convoso Connect Logs tab.
11.) Click the View button for the selected log entry.
The Input Data window will open, showing your Post string.
12.) Click the Close button.
Note: Our system sends API posts on many servers. If your CRM has a Whitelist implemented on their end, they need to add this network range: 66.85.240.0/21