Overview

Convoso Connects are used to either GET or POST data that is either JSON or XML through API.

To learn more about API see: What is an API and How Do I use it?

Note: The API URL, Response Type, and Output data type are mandatory and will need to be supplied by your vendor.

Edit Convoso Connects

1.) Click the Apps main menu.

2.) Click the Convoso Connect menu option.

The Show Convoso Connect page will open.

Open Show Convoso Connect.png

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 –
- GET – API Vendor will be posting a Lead into the system.
- POST – The system will be posting Leads to the third-party API Vendor.
(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,value3')
(G) API Integrator -
Drop-down for integrations built into the Convoso system.
- None -
  This option is for when you do not need an API Integrator.
- Hubspot -
  A CRM software.
- Blue Ink Digital -
  A Lead Generation service.
(H) Delimiter -
To specify which character to use as a boundary between separate keys and values.
(I) Response Key -
To declare a specific key and value to parse from the third-party API's response.
(J) Adaptor ID –
If the Request Method is POST, we need to select the Adaptor ID assigned to the Vendor.
(K) Active –
Yes or No toggle switch, that activates and deactivates the Convoso Connect.