Custify Data Source
Custify
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 Custify connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Custify instance, and click Next; or, create a new Custify credential for use in this flow.
-
In Nexla, Custify data sources can be created using pre-built endpoint templates, which expedite source setup for common Custify endpoints. Each template is designed specifically for the corresponding Custify endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.Custify sources can also be configured manually, allowing you to ingest data from Custify 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 Custify endpoints. Each template is designed specifically for the corresponding Custify 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.
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
Custify data sources can be manually configured to ingest data from any valid Custify 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 Custify sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.
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 Custify API from the Method pulldown menu. The most common method for Custify data retrieval is:
- GET: For retrieving data from the API. All Custify read operations use GET requests.
- POST: For sending data to the API or triggering actions.
API Endpoint URL
- Enter the URL of the Custify API endpoint from which this source will fetch data in the Set API URL field. All Custify API endpoints use the base URL
https://app.custify.com/api/followed by the resource path. For example:https://app.custify.com/api/people— retrieves all peoplehttps://app.custify.com/api/company— retrieves all companieshttps://app.custify.com/api/subscription— retrieves all subscriptions
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 Custify API endpoints, refer to the Custify API documentation.
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.
Date/time macros are particularly useful with Custify's updated_after query parameter, which filters results to records updated after a specific date. For example, appending ?updated_after={'{now-7}'} to the people endpoint URL retrieves only people updated in the last 7 days.
-
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-30)to indicate the datetime 30 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. Custify's
updated_afterparameter expects ISO 8601 format (e.g.,2024-01-01T00:00:00Z). -
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 pass a Custify company ID or person ID retrieved from another Nexla source directly into the API URL—for example, when fetching people for a specific company using https://app.custify.com/api/company/{'{company_id}'}/people.
-
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 returned by the API endpoint is needed, you can designate the part 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. Custify API responses typically return records nested within a named array.
For example, the Custify people endpoint returns a response like {"people": [...], "total": 100}. By specifying $.people[*] as the path to data, Nexla treats each element of the people array as a separate record.
Common Custify response data paths include: $.people[*] for people, $.companies[*] for companies, $.subscriptions[*] for subscriptions, $.deals[*] for deals, $.tasks[*] for tasks, $.notes[*] for notes, $.tickets[*] for tickets, and $.tags[*] for tags.
-
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.,
$.people[*]to access the array of people records within the response object).
Path to Data Example:If the Custify API response contains a top-level array named
peoplethat contains the relevant data, the path to the response would be entered as$.people[*]. - 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.,
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. For Custify responses, this is useful for capturing pagination metadata such as total record counts alongside your data records.
-
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.
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).You do not need to include the
Authorizationheader or other headers already present in your Custify credential. Nexla automatically includes the Bearer token authentication header based on your configured credential.
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 Custify 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.