Here, we will discuss configuring Convoso Connect for a POST Request.
This feature, commonly used by Admins, utilizes API to integrate Lead information in our system with third-party systems.
Configuring Convoso Connect for a POST 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. Displaying 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
- POST – Convoso Connect will POST to a third-party system.
- Post Data Type
- RAW - The system will send the POST String in RAW format.
- JSON - The system will send the POST String in JSON format.
- (F) Response Data Type
Select the Data Type that is compatible with the third-party API.
- This tells the system what type of data the third-party system uses to send a response.
Note: If this is not selected correctly, Convoso will not understand the response from the third party, which will result in a null or blank response entry in the Convoso Connect Logs.
- J: Adaptor ID
If the Request Method is POST, we must select the Adaptor ID assigned to the Vendor.
For more about Adaptors, see Adding, Editing, and Deleting Adaptors.
7.) Click the 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 "Check result on the Convoso Connect Logs tab" message 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: 188.8.131.52/21