Skip to main content

Apptivo Data Source

Apptivo is a cloud-based business management suite offering CRM, invoicing, project management, and customer support tools for small to medium businesses. Follow the instructions below to create a new data flow that ingests data from an Apptivo source in Nexla.
apptivo_api.png

Apptivo

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 Apptivo connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Apptivo instance, and click Next; or, create a new Apptivo credential for use in this flow.

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

    Apptivo sources can also be configured manually, allowing you to ingest data from Apptivo 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 Apptivo endpoints. Each template is designed specifically for the corresponding Apptivo 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.

    List Customers

    This endpoint retrieves all customer records from the Apptivo Customers app using the getAllCustomers action against the v6/customers endpoint. Use it to sync your full customer roster into a warehouse or downstream system, or to obtain customer IDs for use with related endpoints.

    • No configuration is required beyond selecting this endpoint. Nexla automatically paginates through the response using the Apptivo startIndex and numRecords parameters, fetching 100 records per page until the response is empty.

    Apptivo customer records represent organizations or companies in your CRM. For the full set of customer attributes returned by this endpoint, see the Apptivo Customers API reference.

    List Contacts

    This endpoint retrieves all contact records from the Apptivo Contacts app using the getAllContacts action against the v6/contacts endpoint. Contacts in Apptivo represent individual people, typically associated with a customer organization. Use this endpoint to sync your contact list into a warehouse, a marketing platform, or another CRM.

    • No configuration is required beyond selecting this endpoint. Nexla automatically paginates through the response, fetching 100 records per page using the Apptivo startIndex and numRecords parameters until no further records are returned.

    List Cases

    This endpoint retrieves all case records from the Apptivo Cases app using the getAllCases action against the v6/cases endpoint. In Apptivo, a case represents a customer support ticket or service issue. Use this endpoint to sync support data into a reporting system or to feed downstream analytics.

    • No configuration is required beyond selecting this endpoint. The request runs as a single static call and returns the available cases for the firm.

    For the full set of case attributes returned by this endpoint and details on related actions, see the Apptivo Cases API reference.

    List Leads

    This endpoint retrieves all lead records from the Apptivo Leads app using the getAllLeads action against the v6/leads endpoint. Leads in Apptivo represent prospective customers at the top of the sales funnel. Use this endpoint to sync lead data into a warehouse, a marketing automation platform, or a reporting tool.

    • No configuration is required beyond selecting this endpoint. Nexla automatically paginates through the response using the Apptivo startIndex and numRecords parameters, fetching 100 records per page until the response is empty.

    For the full set of lead attributes returned by this endpoint and details on related actions, see the Apptivo Leads API reference.

    List Opportunities

    This endpoint retrieves all opportunity records from the Apptivo Opportunities app using the getAllOpportunities action against the v6/opportunities endpoint. Opportunities represent active sales deals tracked through your pipeline. Use this endpoint to sync pipeline data into a warehouse or BI tool for forecasting and reporting.

    • No configuration is required beyond selecting this endpoint. Nexla automatically paginates through the response, fetching 100 records per page using the Apptivo startIndex and numRecords parameters until no further records are returned.

    Get Cases Configuration Data

    This endpoint retrieves configuration data and settings for the Apptivo Cases app — for example, the getConfigData action returns metadata such as status values, priority lists, and custom field definitions. Use it to interpret case records returned by the List Cases endpoint or to drive validation logic in downstream systems.

    • Enter the Apptivo case action in the Action field. This value is passed as the a query parameter on the v6/cases endpoint — for example, getConfigData. Refer to the Apptivo Cases API reference for the full list of supported action values.

    Action names are case-sensitive and must match the Apptivo API exactly. See the Apptivo Cases API reference for supported actions.

    Get Leads Configuration Data

    This endpoint retrieves configuration data and settings for the Apptivo Leads app. The getConfigData action returns metadata such as lead source lists, status values, and custom field definitions. Use it to interpret lead records or to drive validation logic in downstream systems.

    • Enter the Apptivo lead action in the Action field. This value is passed as the a query parameter on the v6/leads endpoint — for example, getConfigData. Refer to the Apptivo Leads API reference for the full list of supported action values.

    Action names are case-sensitive and must match the Apptivo API exactly. See the Apptivo Leads API reference for supported actions.

    Get Customers Configuration Data

    This endpoint retrieves configuration data and settings for the Apptivo Customers app. The getConfigData action returns metadata such as customer status values, industry categories, and custom field definitions configured for the firm.

    • Enter the Apptivo customer action in the Action field. This value is passed as the a query parameter on the v6/customers endpoint — for example, getConfigData. Refer to the Apptivo Customers API reference for the full list of supported action values.

    Action names are case-sensitive and must match the Apptivo API exactly. See the Apptivo Customers API reference for supported actions.

    Get Contacts Configuration Data

    This endpoint retrieves configuration data and settings for the Apptivo Contacts app. The getConfigData action returns metadata such as contact role values, communication preferences, and custom field definitions used to model contacts in your firm.

    • Enter the Apptivo contact action in the Action field. This value is passed as the a query parameter on the v6/contacts endpoint — for example, getConfigData. Refer to the Apptivo Contacts API reference for the full list of supported action values.

    Get Opportunities Configuration Data

    This endpoint retrieves configuration data and settings for the Apptivo Opportunities app. The getConfigData action returns metadata such as sales stage values, opportunity types, and custom field definitions used to model deals in your firm.

    • Enter the Apptivo opportunity action in the Action field. This value is passed as the a query parameter on the v6/opportunities endpoint — for example, getConfigData. Refer to the Apptivo Opportunities API reference for the full list of supported action values.

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​

Apptivo data sources can be manually configured to ingest data from any valid Apptivo 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 Apptivo sources, such as sources that target additional Apptivo apps (for example, Invoices, Projects, or Items) or sources that use chained API calls to fetch data across multiple endpoints.

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 Apptivo 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 Apptivo 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 query parameters. Apptivo API endpoints follow the format https://app.apptivo.com/app/dao/v6/<object>?a=<action> — for example, https://app.apptivo.com/app/dao/v6/customers?a=getAllCustomers. The Apptivo API requires the apiKey and accessKey parameters to be passed with every request; these are handled automatically by Nexla based on your credential configuration.

The Apptivo API uses an a query parameter to indicate the action to perform on a given object (for example, getAllLeads, getConfigData, or save). The complete list of supported actions is documented per object in the Apptivo Developer API guide.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is useful for Apptivo endpoints that accept date filters to ingest only records changed within a specific time window.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data. For Apptivo, this is useful for driving record-level endpoints — for example, referencing a list of customer IDs to fetch details for each one.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by the 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 because Apptivo list responses wrap the records in a top-level data array alongside summary metadata.

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., $.data.items[*] to access an array of items within a data object).

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

    Apptivo list endpoints return a top-level array named data. For the v6/customers?a=getAllCustomers endpoint, which returns the records in the data array, the path to the response would be entered as $.data[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, Apptivo list responses include fields such as total record counts alongside the records array. If you have specified the path to the relevant records but want to retain that contextual metadata, you can specify a path to the metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

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

    You do not need to include any headers already present in the credentials. The Apptivo apiKey and accessKey parameters are appended to the URL 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 Apptivo 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.