Skip to main content

Gainsight PX 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 Gainsight PX location.
gainsight_px_api.png

Gainsight PX

Create a Gainsight PX Destination​

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

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

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

    Gainsight PX destinations can also be configured manually, allowing you to send data to Gainsight PX 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 Gainsight PX endpoints. Each template is designed specifically for the corresponding Gainsight PX endpoint, making destination setup easy and efficient.

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

    Upsert Account

    Creates or updates an account in Gainsight PX based on the identifyId field. Use this endpoint to sync account data from your CRM, billing system, or data warehouse into Gainsight PX to keep account profiles current.

    • This endpoint uses a POST request to the Gainsight PX Accounts API. If an account with the specified identifyId already exists, its attributes will be updated. If no matching account is found, a new account record will be created.
    • The request body is automatically populated from the mapped Nexset data. Ensure that the Nexset data includes the required identifyId field that Gainsight PX uses to match or create the account record.
    • Custom account attributes defined in your Gainsight PX subscription can be included in the payload alongside the standard fields.

    The identifyId is the primary key used by Gainsight PX to identify accounts. This value should match the account identifier already in use in your Gainsight PX subscription. For full field requirements and payload format, refer to the Gainsight PX API documentation for Accounts.

    Update Account

    Updates an existing account in Gainsight PX. The accountId is passed in the request body and supports IDs that contain special characters. Use this endpoint when you need to update attributes for accounts that already exist in Gainsight PX, without creating new records.

    • This endpoint uses a PUT request to the Gainsight PX Accounts update endpoint. Only accounts that already exist in Gainsight PX will be updated — no new account records are created.
    • The request body is automatically populated from the mapped Nexset data. Ensure that the Nexset includes the accountId field that identifies the account to be updated in Gainsight PX.
    • Any account attributes not included in the request body will retain their existing values in Gainsight PX.

    Use Update Account when you need strict update-only behavior and want to prevent accidental creation of new account records. For create-or-update behavior, use the Upsert Account endpoint instead. For full API details, refer to the Gainsight PX API documentation for Update Account.

    Upsert User

    Creates or updates a user in Gainsight PX, matching on identifyId and updating their profile and account association. Use this endpoint to sync user data from your identity system, CRM, or database into Gainsight PX to keep user profiles accurate.

    • This endpoint uses a POST request to the Gainsight PX Users API. If a user with the specified identifyId already exists, their attributes and account association will be updated. If no matching user is found, a new user record will be created.
    • The request body is automatically populated from the mapped Nexset data. Include the identifyId field, along with profile fields such as email, firstName, lastName, and accountId as appropriate.
    • Custom user attributes defined in your Gainsight PX subscription can be included in the payload alongside standard profile fields.

    The identifyId is the primary key used by Gainsight PX to identify users. This value should be the same identifier used when the user was first tracked in Gainsight PX (typically the internal user ID from your application). For full field requirements and payload format, refer to the Gainsight PX API documentation for Users.

    Update User

    Updates an existing user in Gainsight PX. The identifyId is passed in the request body and supports IDs that contain special characters. Use this endpoint when you need to update attributes for users that already exist in Gainsight PX, without creating new records.

    • This endpoint uses a PUT request to the Gainsight PX Users update endpoint. Only users that already exist in Gainsight PX will be updated — no new user records are created.
    • The request body is automatically populated from the mapped Nexset data. Ensure that the Nexset includes the identifyId field that identifies the user to be updated in Gainsight PX.
    • Any user attributes not included in the request body will retain their existing values in Gainsight PX.

    Use Update User when you need strict update-only behavior and want to prevent accidental creation of new user records. For create-or-update behavior, use the Upsert User endpoint instead. For full API details, refer to the Gainsight PX API documentation for Update User.

    Track Custom Event

    Sends a custom event to Gainsight PX to track user actions, product usage, or business milestones from external systems. Use this endpoint to record events that originate outside your product's front end — for example, back-end actions, billing events, or support interactions — and make them available in Gainsight PX analytics and engagement targeting.

    • This endpoint uses a POST request to the Gainsight PX custom events API. Each record in the Nexset will be sent as a separate custom event payload.

    • The request body is automatically populated from the mapped Nexset data. Each custom event payload should include the following fields:

      • identifyId — The unique identifier of the user associated with the event.
      • accountId — The unique identifier of the account associated with the event (optional but recommended).
      • eventName — The name of the custom event as registered in Gainsight PX.
      • date — The timestamp of the event in Unix epoch milliseconds.
      • attributes — A JSON object of custom properties specific to the event (optional).

    Custom events must be registered in your Gainsight PX subscription before they can be tracked via the API. Unregistered event names will be rejected. For full payload requirements and field details, refer to the Gainsight PX REST API documentation.

Configure Manually​

Gainsight PX destinations can be manually configured to send data to any valid Gainsight PX API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Gainsight PX 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 Gainsight PX API from the Method pulldown menu. The Gainsight PX REST API uses:

    • POST: For creating new records or sending events
    • PUT: For updating existing records (accounts or users)

Data Format​

  1. Select the format in which the Nexset data will be sent to the Gainsight PX API from the Content Format pulldown menu. Gainsight PX accepts data in JSON format, so select JSON to ensure Nexla sends the correct content type with each API call.

API Endpoint URL​

  1. Enter the URL of the Gainsight PX API endpoint to which you want to send the Nexset data in the URL field. The base URL depends on your data residency region:

    • US: https://api.aptrinsic.com/v1
    • EU: https://api-eu.aptrinsic.com/v1
    • US2: https://api-us2.aptrinsic.com/v1

    Append the specific resource path to the base URL. For example, to upsert accounts, enter https://api.aptrinsic.com/v1/accounts.

For a full list of available write endpoints and their URL paths, refer to the Gainsight PX REST 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-APTRINSIC-API-KEY authentication header in this field. This header is added automatically by Nexla based on the API key stored in your Gainsight PX credential.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Gainsight PX 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.

  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. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Gainsight PX 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 Gainsight PX 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 Gainsight PX 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 Gainsight PX 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 Gainsight PX endpoint, open the destination resource menu, and select Activate.

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