Integrations

How to Integrate Cliniko CRM with RingQ

How to Integrate Cliniko CRM with RingQ

Integrating Cliniko CRM with RingQ allows for seamless communication and streamlined management of client information. Follow these steps to complete the integration:

Step 1: Access Cliniko

  1. Log into RingQ Web App: Start by signing into your RingQ account using your credentials.

  1. Reveal the Side Menu: Click on the Show Side Menu button, located in the top left corner of your dashboard. This action will display the side menu bar.

Step 2: Navigate to Settings

  1. Open the Settings Menu: Locate and click on the Settings option in the side menu.

 

  1. Access Global Settings: Click on the dropdown button next to Settings to view additional options.




  1. Select Global from the list.

 

Step 3: Integrate with CRM

  1. Go to Integrations: In the Global Settings section, find and click on Integrations to manage third-party connections.



  1. Select CRM: Within the Integrations menu, navigate to CRM and select Cliniko from the available options.

 

Step 4: Fill Out Required Details







You will need to provide the following information to complete the integration:

  • Username: Enter your Cliniko username.

 

  • Password: Input your Cliniko password for authentication.




  • App Vendor Name: Specify the name of the application or vendor (e.g., RingQ).

 

  • App Vendor Email: Provide the email address associated with the application vendor.





  • URL: Enter the URL for the Cliniko API (ensure it is the correct endpoint).

 

  • API Key: Paste your unique API key, which you can generate in your Cliniko account settings.





Step 5: Save Your Settings

Once all required fields are completed:

  1. Click Save: Ensure all entered information is accurate, then click the Save button to finalize the integration.



How to Set Up Cliniko Using Call Landing in RingQ

How to Set Up Cliniko Using Call Landing in RingQ

  1. Log into RingQ Web App: Start by signing into your RingQ account using your credentials.

  1. Reveal the Side Menu: Click on the Show Side Menu button, located in the top left corner of your dashboard. This action will display the side menu bar.

Step 2: Navigate to Settings

  1. Open the Settings Menu: Locate and click on the Settings option in the side menu.

 

  1. Access Global Settings: Click on the dropdown button next to Settings to view additional options.




  1. Select Global from the list.

 

   4.  Select Call Landing
Navigate to the Call Landing section within the RingQ Global. This section allows you to define how incoming calls are managed and routed.



   5.  Access the Call Landing Dropdown
Click on the Call Landing Dropdown button. This will reveal a list of available options for how to handle calls when they come in.

 

   6.  Choose Open URL or CRM
From the dropdown menu, select Open URL or CRM. This option enables you to specify which external application (in this case, Cliniko) will be opened during a call.

   7.  Select Cliniko
After selecting Open URL or CRM, you will see a list of integrated applications. Locate and select Cliniko from this list. This step ensures that the integration will redirect calls to your Cliniko account.

 

   8.  Save Your Changes
Once you’ve selected Cliniko, make sure to click the Save button to apply your changes. This action will ensure that the configuration is stored and that your calls will now interact with Cliniko as intended.

 

 

How to Set Up Cliniko Using Queue Settings in RingQ

How to Set Up Cliniko Using Queue Settings in RingQ

  1. Log into RingQ Web App: Start by signing into your RingQ account using your credentials.

  1. Reveal the Side Menu: Click on the Show Side Menu button, located in the top left corner of your dashboard. This action will display the side menu bar.




Step 2: Navigate to Settings

  1. Open the Settings Menu: Locate and click on the Settings option in the side menu.

 

  1. Access Global Settings: Click on the dropdown button next to Settings to view additional options.



  1. Access Call Flow Settings
    Begin by logging into your RingQ account. From the main dashboard, navigate to the Call Flow section in the menu. This is where you can manage how incoming calls are handled.

 

  1. Select a DID Number
    In the Call Flow section, locate and select a DID (Direct Inward Dialing) number that is assigned to a specific queue. Click on the DID number to open its settings. This will allow you to configure call handling for that specific number.

  1. Navigate to Queue Settings
    After selecting the DID number, scroll down to find the Queue Settings section. This area controls how calls are distributed within the queue.

 

  1. Open the Dropdown Menu
    Click on the dropdown button within the Queue Settings. This will reveal various options for call handling.

  1. Select Open External URL or CRM
    From the dropdown menu, choose Open External URL or CRM. This option enables you to redirect calls to an external application, allowing for enhanced functionality.

 

  1. Choose Cliniko from the Options
    After selecting the external option, click on the External URL or CRM Dropdown. This will display a list of integrated applications. Locate and select Cliniko from the list to ensure that calls are directed to your Cliniko account.

  1. Save Your Configuration
    Once you have made your selection, click the Save button to apply the changes. This step is essential to ensure that your new call handling settings are activated.

 

 

How to Set Up Cliniko with RingQ

How to Set Up Cliniko with RingQ

Follow these steps to seamlessly integrate Cliniko with RingQ:

  1. Access the Cliniko Login Page
    Open your web browser and go to Cliniko's login page.

  1. Log into Your Cliniko Account
    Enter your credentials to log in to your Cliniko account. Ensure you have the necessary permissions to manage API keys.

  1. Navigate to My Info
    Once logged in, locate the side menu bar on the left-hand side of the dashboard. Click on My Info.

 

  1. Manage API Keys
    In the My Info section, look for Manage API keys. API keys are crucial as they enable integration with external applications like RingQ.



  1. Add a New API Key

    • Click on Manage API keys to open the API key management section.

    • Then, click on Add an API Key.

 

  1. Enter the Webapp Name
    In the prompted field, enter a descriptive name for your Web App. This name should help you identify the API key later, especially if you plan to create multiple keys.

 

  1. Create the API Key
    After entering the name, click on Create API Key.

 

  1. Copy the API Key
    Once the API key is generated, it will be displayed on the screen. Make sure to copy this key immediately, as you won’t be able to view it again later. Store it securely.



  1. Finalize Your Changes
    After copying the API key, click the Done button to exit the API key management section.

 

  1. Next Steps for Integration
    You are now ready to proceed with integrating Cliniko CRM with RingQ. Follow the specific instructions provided by RingQ for the integration process.

 

 

Obtaining Your Autotask API Code for RingQ Integration.

Obtaining Your Autotask API Code for RingQ Integration

Follow the steps below to obtain the necessary API code from Autotask for integrating with RingQ:

1. Log in to Your Autotask Account

    • Open your browser and go to the Autotask login page. ww6.autotask.com

    • Enter your valid username and password, then click on the Login button.

    • Then enter the Autentication Code sent to your authetication app integrated with Autotask.

    • You will be redirected to your Autotask Dashboard upon successful login.

2. Navigate to the Admin Section

    • In the top left corner of the dashboard, locate and click on the hamburger icon (three horizontal lines) to open the main menu.

    • This will display a list of options available for your Autotask account.

3. Access Resources

    • In the expanded menu, click on Admin.

    • From the Admin dropdown menu, select Resources (also referred to as Users).

4. View Existing User Accounts

    • After selecting Resources (Users), you will be redirected to a page listing all existing accounts and users in your Autotask system.

5. Add a New API User

    • On the Users page, locate the Add New User section.

    • Click on the dropdown button next to Add New User to expand the options.

6. Select ‘New API User’

    • From the dropdown list, select the New API User option. This will take you to the page where you can create an API user for the integration.

7. Fill Out the Required Fields for the New API User

When you are directed to the page for creating a new API user, you will need to fill out the required fields in the form. Below is a breakdown of each section and what you need to provide:

General Information

Complete the following fields with the necessary details for the new API user:

  • First Name: Enter the first name of the API user.

  • Last Name: Enter the last name of the API user.

  • Email Address: Provide a valid email address associated with the API user account.

You will also need to select the appropriate options for the following dropdown fields:

  • Security Level: Choose one of the following security levels:

    • API User (System): Standard system-level access for the API user.

    • API User (System) Can’t Read Costs: Limited access, preventing the API user from reading cost-related data.

  • Date Format: Select the date format that is appropriate for your region or business preferences.

  • Time Format: Choose whether to use the 12-hour or 24-hour time format.

  • Number Format: Select the number format that aligns with your region's conventions (e.g., decimal separators or grouping for thousands).

 

  • Primary Internal Location: Select the primary internal location from the dropdown menu, indicating where the API user will operate.

Credentials

This section is crucial for generating the authentication details required for API access:

  • Username (Key): This is the unique identifier for the API user.

    • The user has the option to regenerate their Username, and the AutoTask system will automatically generate a unique one for them.

    • This key is used for authentication when making API calls.

    • Be sure to note or copy the Username Key for entry in the Username panel under AutoTask Settings in the RingQ integration.

         

  • Password (Secret): This is the secret password used for authentication with the API.

    • The user has the option to regenerate their Secret Key, and the AutoTask system will automatically generate a unique one for them.

    • Be sure to save the secret in a secure place, as it will not be retrievable later.

    • Be sure to note or copy the Secret Key for entry in the Secret panel under AutoTask Settings in the RingQ integration.

         

API Tracking Identifier

  • API Tracking Identifier: For API versions 1.6 and later, you will need to assign an API tracking identifier to the user.

    • Once this identifier is assigned, it cannot be changed.

    • This ID helps with tracking and logging API usage and activity.

  • Integration Vendor: Select from the dropdown to specify the type of integration you are using.

    • Integration Vendor: Choose this option if you're integrating through an official vendor.

    • Custom (Internal Integration): Select this if you're setting up a custom internal integration for your business or service.

    • Choose Custom (Internal Integration) to have access to the API Code.

    • Be sure to note or copy the Tracking Identifier or API Key for entry in the API Integration Code panel under AutoTask Settings in the RingQ integration.

     

8. Save and Create the API User

    • After filling out all the required fields, click on the Save & Close button at the bottom of the form.

    • This action will create the new API user, and you will be able to use the credentials for the RingQ integration.

9. Obtaining Credentials

    • After the successful creation of the API User, go to the Resources page to view all the created API Users.

  •  
    • Use the search panel to find the API User you created.

  •  
    • On the Resource page, the API User you search for will be displayed. From there, you can retrieve the Resource ID, which should be entered in the "Owner Resource ID" field under AutoTask Settings in the RingQ integration.

           

To get the Username

  • Click on the selected API User to view its credentials.

          

  • Navigate to the Username (Key).

  • The user has the option to regenerate their Username, and the AutoTask system will automatically generate a unique one for them.Copy the Username (Key) for entry in the Username panel under AutoTask Settings in the RingQ integration.

          

 

To get the Secret Key

  • Click on the selected API User to view its credentials.

          

  • Navigate to the Secret Key.

  • The user has the option to regenerate their Secret Key, and the AutoTask system will automatically generate a unique one for them.
  • Copy the Secret Key for entry in the Secret panel under AutoTask Settings in the RingQ integration.

          

 

To get the API Integration Code

  • Click on the selected API User to view its credentials.

         

  • Navigate to the Tracking Identifier.

  • Copy the Tracking Identifier for entry in the Integration Code under AutoTask Settings in the RingQ integration.

          

 

To get the URL

 

  • Click on the selected API User to view its credentials.

          

  • Copy the URL from the address bar or navigation bar.