1. Help Center
  2. Custom API Integrations

Guide: Using Vtiger with Databox (Custom API Integration)


Vtiger Integration Details



Vtiger is an open source CRM system that improves your interactions with customers, helps you market to potential clients, and streamlines your communication with other employees and the public. 

The Vtiger integration is designed for more tech-savvy users, as it syncs data through a Custom API integration. In order to create Vtiger metrics in Databox, you’ll need to use the Metric Builder. Learn more about the basics of Metric Builder for Custom API Integrations here

Custom API Integrations are available on Professional and higher plans. Request a trial of Metric Builder by following these steps

If you'd like us to help you get set up with Vtiger in Databox, please fill out this request form or book a call with one of our product experts: 

- Free Databox users (or potential users) book a call here

- Paying Databox customers book a call here

Integration basics

Integration status Beta
Type of Account access needed Not specified
Authorization type Basic
Available endpoints All
Available requests GET
Needed permissions (scopes) None
Allowed API versions All currently active API versions.
Example: You can use a v1 of an API or v4, as long as they are both still supported. Deprecated APIs normally stop returning data.
Timezone Users timezone
Dynamic date range support Yes
Pagination support No
Type of Pagination supported /
Rate Limits Yes
Official documentation
Follow the status of the API on the official changelog  /

How to connect Vtiger to Databox


How to connect Vtiger to Databox

To connect a Vtiger Account in Databox, go to  Data Manager > + New connection. Type Tvitger in the search bar and click on the Connect button. Next, click the green Connect now button.

This will open the  Authorization window, which is where you will be prompted to enter your Subdomain, Username and Access Key to authorize the Databox app. Learn how to access your Subdomain, Username and Access Key here

How to access your API key, access token / API key secret?

To successfully connect your Vtiger with Databox, you will need to use your  Subdomain, Username and Access Key in the connect process. 

Your subdomain is visible in your URL while using Vtiger app. Example: https://{ your_domain}.vtiger.com. Copy your subdomain from your URL and paste it in Databox's Activate Vtiger window.

To access the  Username and Access Key in your Vtiger Account, follow the steps below:

  1. Login to your Vtiger Account.
  2. Navigate to your Profile icon > My Preferences
  3. Copy your Username and Access Key from here and paste it in the Databox's Activate Vtiger Window.
  4. Once you have pasted the  Subdomain, Username and Access Key in Databox's Activate Vtiger Window, click the green Activate button to authorize the Databox app.

What's the maximum amount of historical data initially available when you use a new Vtiger Data Source Metric in Databox?

The amount of historical data available in Databox is dependent on the custom metric setup, API limitations, pagination limitations, and the user’s Databox plan:
  • Custom Metric Setup: When a user creates a metric using an endpoint that supports date time parameters in the API request, those date time parameters determine the amount of historical data that will be pulled for the given metric. You can learn more about the date time parameters here.
  •  API Limitations: APIs may have limits set by the system itself on the amount of historical data that is stored/ can be accessed.
  •  Pagination Limitations: The pagination limit is set to 100 pages, which means that pagination will stop when the 100th page is reached. In cases where the metric is using pagination, of course, the interplay of date time parameters and pagination can have an impact on how much of the historical data the user can pull for a given metric. Learn more here.
  •  Databox Plan: The amount of historical data you're able to access in Databox is dependent on your Databox plan. Learn more here.
Pro Tip: In order to start syncing data for a Metric, you can add it to your Metrics screen, use it in a Scorecard, set a Goal around it, create an Alert for it, or add it to a Databoard. Learn more here.    

What time zone does Vtiger data sync in? 

Vtiger's data syncs in the user's timezone. However, you will need to set this after connecting. The default timezone of your Vtiger instance is found in the configuration file, learn more here
You can set your Data Source's timezone by following these steps.

What type of pagination is supported by Vtiger Integration

Learn more about pagination here.

How to use and create Vtiger Metrics


How to access pre-built Vtiger Metrics

  1. Navigate to Metrics > Metric Library.
  2. In the  Browse by Data Source section, click the Data Source dropdown and search for Zoho CRM. This will filter out pre-built Zoho CRM Metrics.

How to create custom Vtiger Metrics

Let’s walk through how to create a Custom Metric for Vtiger.

In order to prepare API requests, you should reference API-specific documentation that can be found in the Databox app through the API Docs link in the top right of the Prepare API Request page. Or, use this direct link.

  1. Navigate to Metrics > Custom Metrics to access the Metric Builder for Vtiger.
  2. Click the green + New Custom Metric button and select your connected Vtiger Account from the Data Source drop-down list.
  3. Open the API documentation for Vtiger to find the endpoint that will return the data needed for the given custom metric you wish to create. 
  4. Click the drop-down to select GET or POST as the HTTP Method. This is dependent on the information you found in the API documentation. 
  5. The Base URL is already predefined, you will need to copy the missing part of your chosen endpoint to sync the appropriate data. 
  6. Add Parameters based on your HTTP Method. Parameters limit the records returned for the API request.
    1. If you’re creating a GET request, define the Key and Value pair(s). The API documentation provides information on endpoints for a field/ argument, which will be the Key. The condition (i.e., an ID, true/ false, etc.) will be the Value. 
      If the API documentation for Vtiger states that the Integration supports dynamic date ranges, you will be able to click the  calendar icon to add datetime parameters.
    2. If you’re creating a POST request, define the relevant JSON body.
      Click on the  calendar icon to add datetime parameters.
    3. Pro Tip: You can choose multiple Keys and Values for one Custom Metric. You can add an additional Key and Value by clicking on “+”. 
  7. You can add Headers that include Key and Value pairs if the API needs this to successfully return data.
  8. If the endpoint supports pagination, we recommend you select the appropriate method using the Pagination Method dropdown. 
  9. Once you have the basic setup, click on the green Continue button. You will be directed to the Select value step.
  10. In the Select value step, select a property that includes the metric value you'd like to track in your Custom Metric. A metric value must be purely numeric. 
  11. Once you have selected the value, click on the green Continue button.
  12. The Segment by dimension step is optional. This step will be taken into account only when you are trying to create a dimensional metric. If you'd like to segment your metric by multiple dimensions, choose one to complete during this set up, then begin again and select a different dimension until each desired metric is created.
    1. To skip this step, select None

  13. The Select date step is optional as well. 
    1. Use current time of storing data (Dynamic): Select this option if you don’t want to select a date field
    2. Use a field from response (optional): Select this if you want to select a date in order to see your data in predefined intervals. 
  14. In the Preview & Customize step, you can see the JSONata expression that has been created based on your selection of properties. 
    1. You can customize the JSONata expression (optional) in the right editor panel. 

  15. To continue, click on the Preview data button to validate the expression and returned data. 
  16. Once you have previewed your data, click on the green Continue button to proceed to the last step of setting up your Custom Metric.
  17. In the Describe metric step, you can set up the following:
    1. Name your metric: Enter a name for your custom metric.
    2. Data Aggregation: These selections determine how your data is handled. This especially impacts the way data is grouped and displayed for longer Date Ranges. Learn more here.
    3. Favourable trend: You can select when "Trending UP is positive" or "Trending DOWN is positive," since some metrics are better (positive) when the value is lower (like Bounce rate, Churn rate, etc.). This will affect how comparison values and goal comparisons are calculated and calculated.
  18. Once you completed the Describe metric step, click the green Continue button to finish the Custom metric setup.

Additional Information


Integration Limitations

  • Databox limits the use of its integrations to GET requests. This is because our integration only reads your data.
  • Rate limits: Your Vtiger API usage limits depend on the Vtiger plan you are subscribed to. Learn more about the Vtiger CRM API Limits here.

WARNING: If specific scopes of an integration allow you to create, change, delete or manipulate data in any other way, using such API calls can result in unexpected behavior. Databox is in no way liable for such API calls.