Skip to main content

People.ai Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a People.ai location.
people_ai_api.png

People.ai

Create a People.ai Destination​

  1. Click the + icon on the Nexset that will be sent to the People.ai destination, and select the Send to Destination option from the menu.

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

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

    People.ai destinations can also be configured manually, allowing you to send data to People.ai endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common People.ai endpoints. Each template is designed specifically for the corresponding People.ai write endpoint, making destination setup easy and efficient. The available endpoint templates cover pushing activity data—such as chat messages, calls, emails, meetings, and conferences—into the People.ai platform, both individually and in bulk.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Push Chat Activity

    Sends a single chat activity record to the People.ai platform. Use this endpoint to push individual chat messages or conversations into People.ai so they can be associated with accounts, contacts, and opportunities and included in engagement analytics.

    • This endpoint sends a single JSON-formatted activity record to the People.ai chat activities API using a PUT request. Ensure the Nexset record structure matches the People.ai chat activity schema before sending.
    • No additional endpoint parameters are required beyond selecting this template. The activity payload is automatically derived from each Nexset record.

    For sending multiple chat activity records at once, use the Push Batch Chat Activities endpoint template instead to reduce the number of API calls and improve throughput.

    Push Batch Chat Activities

    Sends a batch of chat activity records to the People.ai platform in a single API call. Use this endpoint when you need to push multiple chat activities at once, reducing API call overhead and improving data loading efficiency.

    • This endpoint sends multiple JSON-formatted activity records to the People.ai bulk chat activities API using a PUT request. The records are grouped and sent together in a single payload.
    • No additional endpoint parameters are required beyond selecting this template. The batch of activity records is automatically derived from the Nexset data.

    Push Single Call Activity

    Sends a single call activity record to the People.ai platform. Use this endpoint to push individual call records into People.ai so they can be matched to accounts, contacts, and opportunities and factored into engagement scores.

    • This endpoint sends a single JSON-formatted call activity record to the People.ai call activities API using a PUT request. Ensure the record includes required call activity fields such as participants, duration, and timestamps as defined in the People.ai API schema.
    • No additional endpoint parameters are required beyond selecting this template.

    For pushing multiple call activity records at once, use the Push Batch Call Activities endpoint template to improve efficiency.

    Push Batch Call Activities

    Sends a batch of call activity records to the People.ai platform in a single API call. Use this endpoint when you need to push multiple call records at once.

    • This endpoint sends multiple JSON-formatted call activity records to the People.ai bulk call activities API using a PUT request.
    • No additional endpoint parameters are required beyond selecting this template. The batch of activity records is automatically derived from the Nexset data.

    Push Single Email Activity

    Sends a single email activity record to the People.ai platform. Use this endpoint to push individual email records into People.ai for association with CRM records and inclusion in engagement analytics.

    • This endpoint sends a single JSON-formatted email activity record to the People.ai email activities API using a PUT request. Ensure the record includes required email fields such as sender, recipients, subject, and timestamps as defined in the People.ai API schema.
    • No additional endpoint parameters are required beyond selecting this template.

    For pushing multiple email activity records at once, use the Push Batch Email Activities endpoint template to reduce API call volume.

    Push Batch Email Activities

    Sends a batch of email activity records to the People.ai platform in a single API call. Use this endpoint when you need to push multiple email records at once to improve data loading efficiency.

    • This endpoint sends multiple JSON-formatted email activity records to the People.ai bulk email activities API using a PUT request.
    • No additional endpoint parameters are required beyond selecting this template. The batch is automatically derived from the Nexset data.

    Push Single Meeting Activity

    Sends a single meeting activity record to the People.ai platform. Use this endpoint to push individual calendar meetings or appointment records into People.ai for CRM association and engagement tracking.

    • This endpoint sends a single JSON-formatted meeting activity record to the People.ai meeting activities API using a PUT request. Ensure the record includes required meeting fields such as attendees, start/end times, and subject as defined in the People.ai API schema.
    • No additional endpoint parameters are required beyond selecting this template.

    For pushing multiple meeting activity records at once, use the Push Batch Meeting Activities endpoint template.

    Push Batch Meeting Activities

    Sends a batch of meeting activity records to the People.ai platform in a single API call. Use this endpoint when loading multiple meeting records at once.

    • This endpoint sends multiple JSON-formatted meeting activity records to the People.ai bulk meeting activities API using a PUT request.
    • No additional endpoint parameters are required beyond selecting this template. The batch is automatically derived from the Nexset data.

    Push Single Conference Activity

    Sends a single conference activity record to the People.ai platform. Use this endpoint to push individual conference or video call records into People.ai for CRM matching and engagement analytics.

    • This endpoint sends a single JSON-formatted conference activity record to the People.ai conference activities API using a PUT request. Ensure the record includes the required fields for conference activities as defined in the People.ai API schema.
    • No additional endpoint parameters are required beyond selecting this template.

    For pushing multiple conference activity records at once, use the Push Batch Conference Activities endpoint template.

    Push Batch Conference Activities

    Sends a batch of conference activity records to the People.ai platform in a single API call. Use this endpoint when loading multiple conference records at once to maximize throughput.

    • This endpoint sends multiple JSON-formatted conference activity records to the People.ai bulk conference activities API using a PUT request.
    • No additional endpoint parameters are required beyond selecting this template. The batch is automatically derived from the Nexset data.

Configure Manually​

People.ai destinations can be manually configured to send data to any valid People.ai API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the People.ai API after each call to a new Nexla webhook data source.

API Method​

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

  2. Select the API method that will be used for calls to the People.ai API from the Method pulldown menu. People.ai's activity write endpoints use the following method:

    • PUT: For creating or upserting activity records in People.ai (used by all activity push endpoints)
    • POST: For other write operations

Data Format​

  1. Select the format in which the Nexset data will be sent to the People.ai API from the Content Format pulldown menu. People.ai's API accepts data in JSON format. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the People.ai API endpoint to which you want to send the Nexset data in the URL field. All People.ai write endpoints use the base URL from your credential (e.g., https://api.people.ai/v0/public) followed by the activity type path (e.g., /activities/email, /activities/call, /activities/meeting).

For bulk write operations, append /_bulk to the activity endpoint path (e.g., /activities/email/_bulk). The complete list of People.ai write endpoints is available in the People.ai API documentation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, 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 X-API-Key authentication header—this is automatically included in every request based on your People.ai credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this People.ai destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching. Batching is recommended when sending large volumes of activity records to People.ai, as it reduces the number of API calls and improves throughput.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the People.ai API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the People.ai API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.

  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the People.ai API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the People.ai API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured People.ai endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to People.ai until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.