Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an Agile CRM source in Nexla.
agilecrm_api.png

Agile CRM

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Agile CRM connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Agile CRM instance, and click Next; or, create a new Agile CRM credential for use in this flow.

  3. In Nexla, Agile CRM data sources can be created using pre-built endpoint templates, which expedite source setup for common Agile CRM endpoints. Each template is designed specifically for the corresponding Agile CRM endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Agile CRM sources can also be configured manually, allowing you to ingest data from Agile CRM endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Agile CRM endpoints. Each template is designed specifically for the corresponding Agile CRM endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get All Contacts

    This endpoint retrieves all contacts in your Agile CRM domain. Use this endpoint when you need to access contact information for analysis, reporting, or integration with other systems.

    • This endpoint uses cursor-based pagination, automatically fetching additional pages as needed. By default, the endpoint retrieves up to 200 contacts per page.
    • The endpoint will return all contacts in your domain, including contact details, custom fields, and associated information.

    This endpoint supports pagination through cursor tokens. Nexla automatically handles pagination to retrieve all available contacts. For detailed information about retrieving contacts, see the Agile CRM REST API documentation.

    Get All Deals

    This endpoint retrieves all deals in your Agile CRM domain. Use this endpoint when you need to access deal information for sales analysis, pipeline reporting, or integration with other systems.

    • This endpoint uses cursor-based pagination, automatically fetching additional pages as needed. By default, the endpoint retrieves up to 200 deals per page.
    • The endpoint will return all deals in your domain, including deal details, stage information, values, and associated contacts.

    This endpoint supports pagination through cursor tokens. Nexla automatically handles pagination to retrieve all available deals. For detailed information about retrieving deals, see the Agile CRM REST API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Agile CRM data sources can be manually configured to ingest data from any valid Agile CRM API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Agile CRM sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Agile CRM API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Agile CRM API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Agile CRM API endpoints typically follow the pattern https://{domain_name}.agilecrm.com/dev/api/{endpoint}, where {domain_name} is your Agile CRM domain name.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a complete list of available Agile CRM API endpoints, see the Agile CRM REST API documentation.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $[*] to access all elements in the root array).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the API response is in JSON format and includes a root-level array that contains the relevant data, the path to the response would be entered as $[*].

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Agile CRM data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.