Skip to main content
All CollectionsHandy How To Guides
Integrating Connex and Voyc
Integrating Connex and Voyc
Joyc from Voyc avatar
Written by Joyc from Voyc
Updated over 2 months ago

This guide will walk you through the process of setting up an integration between Connex and Voyc. Follow the steps below to ensure a smooth integration.

Step 1: Log in to Connex

  1. Navigate to the Connex site and log in using your credentials.

  2. Once logged in, go to the Admin section at the bottom left-hand corner of the navigation menu.

Once clicked, you’ll be navigated to a page for generating the Client ID and the Client Secret. Let’s delve into it in the next section.

Step 2: Generate API Client ID and Client Secret

  1. From the Admin panel, go to API > API Client.

  2. Click on Create API.

  3. Provide a name for the API (e.g., "Voyc Integration").

  4. Click next, and a confirmation page will appear.

  5. Copy the Client Secret as you won’t be able to access it again. Paste it into the designated section in Voyc under Client Secret.

  6. Click Close.

💡Voyc Tip: Always store the Client Secret securely, as you won't be able to retrieve it after this step. Consider keeping a separate document with these credentials for backup purposes.

Now, retrieve the Client ID for the newly created API and paste it into Voyc under Client ID.

Step 3: Create API Credentials

Now go back to the API section in Connex and select API Credentials.

  1. Click on Create API Credentials.

  2. Name the API (e.g., "Voyc Demo").

  3. Set the expiry date (e.g., 2030/08/27).

  4. Fill in the username (e.g., "Voyc") and create a password. Make sure the credentials are enabled by moving the toggle. Once done, click Next.

  5. Copy the API Token and click Back to API.

  6. Paste the API Token into the API Token section in Voyc. Navigate to the section above called Auth Type and click the dropdown menu to select Basic.

📝Take Note: If the API token contains terms like "Basic" or "Bearer," be sure to remove those terms and use only the token itself for a smooth integration. Then, in the Auth Type dropdown menu, select the corresponding option (either "Basic" or "Bearer") based on the word included in the token. If the token doesn’t specify "Basic" or "Bearer," assume it’s "Bearer."

Step 4: Base URL Configuration

Let’s now move on to the API base URL, click Close and head back to the Admin panel in Connex.

  1. Click Back to API and click Back to Admin.

  2. Scroll down and click Apps and Integrations.

  3. Select View API Documentation to open the documentation window.

  4. Scroll down and navigate to a section titled Xbearer. This is where you’ll find the API Gateway URL.

  5. Copy the API Gateway URL (ending with .cloud). Also, ensure that it starts with “apigateway”

  6. Paste the URL into the API Base URL field in Voyc.

💡Voyc Tip : When copying the API Gateway URL, make sure it ends in .cloud without any extra characters like a forward slash /. This will ensure proper routing during integration.

Step 5: Set Up the Integration

  1. Return to the Connex platform, navigate to Integrations, and click on Create Integration.

  2. Provide a name (e.g., "Voyc Integration").

  3. Select Routine as the type.

  4. Set Customer Routine to True and click next.

  5. For triggers, select Interaction Ended.

  6. Select all relevant data fields once done, click next.

  7. Head back to Voyc, and Copy the URL.

  8. Paste the URL on the URL section on the integrations page and click next.

📝Take Note : If you don’t see routines from the drop down menu, you can create it on Marketplace.

How to set up Routines on Marketplace?

To set up routines on Marketplace, follow these steps:

  1. Begin by clicking on Marketplace.

  2. Scroll down and select Routines.

  3. In the top-right corner of your screen, click the Install button.

  4. A confirmation message will appear at the bottom-right corner of your screen, indicating that the routine has been installed successfully.

Step 6: Configure Data & Attributes

  1. Choose the desired Campaigns, Outcomes, and Interaction Types (e.g., select all for campaigns and outcomes, and select "voice" for interaction types). Once done click next.

  2. Under Advanced rules, click next.

  3. For filters copy the standard JSON code that is on Voyc and paste it on the filter section.

  4. If needed, use the Filter section to include any additional custom attributes. This can be done by adding the required fields under the Custom Attribute section.

  5. Click next to proceed

💡Voyc Tip : Before you paste the JSON code on the filter field, first remove the .

📝Take Note : If your integration requires custom data fields that are not listed, you can always add them later through the Custom Attribute section.

Step 7: Finalise and Enable the Integration

  1. Review the settings and click Finish.

  2. Once completed, you’ll see the integration listed as Enabled.

Frequently Asked Questions

What is the Client ID, and where do I find it?

The Client ID is generated when you create an API in Connex. You can find it in the API Client section under Admin.

What should I do if my API Token contains 'Basic'?

Simply remove the word "Basic" and only keep the API Token. If the token doesn't have the word "Basic," select "Bearer" instead.

How do I add additional attributes to the integration?

You can add extra attributes under the Custom Attribute section by defining the name and corresponding data for each attribute.

Can I update the integration settings after completion?

Yes, you can always revisit the integration settings in Connex to make updates or adjustments as necessary.

Did this answer your question?