In this Article:

Convoso Connect is the interface we use to communicate with third-party apps via API (Application Programming Interface). This is where you input the URL of the software you would like to integrate along with the API Authentication Method. The path and password allow you to update the external software. 

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

1.)Click on Apps.

2.) Select Convoso Connect.

The Show Convoso Connect page will open.

3.) Click the Add Convoso Connect button.

The Add Convoso Connect page will open. Displaying the General Tab.

4.) Fill the following fields with your Vendor information in the Convoso Connect General Settings section.

Note: Three settings marked G, H, and I are optional and not required for your Convoso Connect to work.

• 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.

5.) Click the Save Convoso Connect button at the bottom of the Convoso Connect General Settings section.

6.) Scroll down to the Test Convoso Connect section.

7.) Enter a Lead ID in the Lead ID field.

8.) Click the Test Convoso Connect button.

A message that says: "Check result on the Convoso Connect Logs tab" will appear.

9.) Scroll up, and click the Convoso Connect Logs tab.

10.) Check your test results in the Results column of the Convoso Connect Logs table.

Note: If your test returns null in the Results column, then you will need to troubleshoot to find out why the apps are failing to communicate.