People.ai Data Source

People.ai
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 People.ai connector tile from the list of available connectors. Then, select the credential that will be used to connect to the People.ai instance, and click Next; or, create a new People.ai credential for use in this flow.
-
In Nexla, People.ai data sources can be created using pre-built endpoint templates, which expedite source setup for common People.ai endpoints. Each template is designed specifically for the corresponding People.ai endpoint, making source configuration easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.People.ai sources can also be configured manually, allowing you to ingest data from People.ai 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 People.ai endpoints. Each template is designed specifically for the corresponding People.ai 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
People.ai data sources can be manually configured to ingest data from any valid People.ai 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 People.ai 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 People.ai API from the Method pulldown menu. People.ai's public API primarily uses the following methods:
- GET: For retrieving data from the API (accounts, contacts, activities, opportunities, teams, etc.)
- PUT: For creating or updating activity records in People.ai
API Endpoint URL
- Enter the URL of the People.ai API endpoint from which this source will fetch data in the Set API URL field. All People.ai API endpoints use the base URL selected in your credential (e.g.,
https://api.people.ai/v0/public), followed by the resource path (e.g.,/accounts,/contacts,/activities).
The complete list of People.ai API endpoints and their URL structures is available in the People.ai API documentation. Ensure the endpoint URL is correct and accessible with your current API key and Base URL configuration.
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. This is particularly useful for People.ai endpoints that accept date range query parameters such as from, to, modified_from, modified_to, ingested_from, or ingested_to.
Date/time macros are especially useful for People.ai activity and engagement score endpoints that support date filtering. For example, you can use macros to automatically retrieve activities modified in the last 24 hours by including a {now-1} macro in the modified_from query parameter.
-
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}. -
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 for People.ai endpoints that require specific IDs as path parameters—for example, using an account ID or team ID retrieved from another Nexla source to dynamically construct the endpoint URL.
-
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(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. People.ai API responses typically wrap records in a named array within the JSON response body, so specifying the correct data path ensures Nexla treats each element of that array as an individual record.
For example, a request to the List Accounts endpoint returns a JSON response with an accounts array. By specifying the path to this array, Nexla will treat each account object as a separate record.
Path to Data is essential for People.ai endpoints that return paginated arrays of records. Common People.ai response data paths include $.accounts[*], $.activities[*], $.contacts[*], $.data[*], $.participants[*], and $.engagementScores[*], depending on the endpoint.
-
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/itemto access item elements within a data element).
Path to Data Example:If the People.ai API response includes a top-level array named
accountsthat contains the relevant records, the path to the response would be entered as$.accounts[*]. -
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 example, a People.ai response may include pagination context such as a total record count alongside the main records array. If you have specified the path to the records array but also want to capture this context, you can specify a separate path to include that metadata with each record.
Metadata paths are particularly useful for preserving People.ai response context like request 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 may be required for API versioning or custom request parameters.You do not need to include the
X-API-Keyauthentication header—this is automatically included in every request based on your People.ai 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 People.ai 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.