ChurnZero Data Source
ChurnZero
Create a New Data Flow
-
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.
-
Select the ChurnZero connector tile from the list of available connectors. Then, select the credential that will be used to connect to the ChurnZero instance, and click Next; or, create a new ChurnZero credential for use in this flow.
-
In Nexla, ChurnZero data sources can be created using pre-built endpoint templates, which expedite source setup for common ChurnZero endpoints. Each template is designed specifically for the corresponding ChurnZero endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.ChurnZero sources can also be configured manually, allowing you to ingest data from ChurnZero 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 ChurnZero endpoints. Each template is designed specifically for the corresponding ChurnZero endpoint, making data source setup easy and efficient.
The ChurnZero REST API is an OData implementation, so most endpoint templates support $top (page size), $filter, and $orderby query options. Many templates expose a Days Back parameter that incrementally ingests records modified or created within a rolling window, and a Page Size parameter that controls how many records are requested per page. Pagination is handled automatically by following the OData @odata.nextLink value in each response.
For incremental endpoints, the Days Back parameter filters records by their last modified or created date relative to the current run time. Set this value to 0 to perform a full sync of all available records, and increase it when backfilling historical data.
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.
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
ChurnZero data sources can be manually configured to ingest data from any valid ChurnZero REST API endpoint. Manual configuration provides maximum flexibility for accessing OData entities not covered by pre-built templates or when you need custom OData query options such as $select, $expand, or custom $filter expressions.
With manual configuration, you can also create more complex ChurnZero sources, such as sources that apply custom date filters or request specific fields to reduce payload size.
API Method
-
To manually configure this source, select the Advanced tab at the top of the configuration screen.
-
Select the API method that will be used for calls to the ChurnZero API from the Method pulldown menu. ChurnZero REST API read operations use the GET method:
- GET: For retrieving data from the API
API Endpoint URL
- Enter the URL of the ChurnZero 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 OData query options. ChurnZero REST API endpoints follow the pattern
https://{subdomain}.churnzero.net/public/v1/{Entity}, where{subdomain}is your account subdomain and{Entity}is an OData entity such asAccount,Contact, orEvent.
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.
Date/Time Macros (API URL)
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. For ChurnZero, datetime macros are commonly used inside OData $filter expressions to ingest only records created or modified since the previous run.
Macros are particularly useful for ChurnZero OData filters such as $filter=ObjectLastModifiedDate gt {now-30}, which limits results to records modified within a rolling window.
-
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 datetimecustom– 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
-
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}. ChurnZero expects ISO 8601 UTC timestamps in the formatyyyy-MM-dd'T'HH:mm:ss'Z'. -
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}, whenDayis selected,{now-1}will be converted to the datetime one day before the current datetime.
Lookup-Based Macros (API URL)
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.
Lookup-based macros are useful when you need to create ChurnZero API endpoints that reference specific account or contact IDs from other data sources in your Nexla environment.
-
To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.
-
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
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 when API responses contain metadata, pagination information, or other data that you don't need for your analysis.
ChurnZero OData responses wrap the returned records in a top-level value array, alongside metadata such as the @odata.nextLink pagination link. By entering the path to the value array, you can configure Nexla to treat each element of the 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.,
$.value[*]to access the array of records in a ChurnZero OData response). -
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/itemto access item elements within a data element).
Path to Data Example:For ChurnZero OData responses, the records are contained in a top-level array named
value, so the path to the relevant data is entered as$.value[*]. -
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.
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 ChurnZero OData responses, the @odata.nextLink pagination link and any OData annotations sit outside the value array. In most cases this metadata is handled automatically for pagination, but you can specify a metadata path to retain selected response-level fields with each record.
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
-
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. The HTTP Basic Authentication header is added automatically by Nexla based on your ChurnZero 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
- 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 ChurnZero 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.