Skip to main content

ClientSuccess 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 ClientSuccess location.
clientsuccess_api.png

ClientSuccess

Create a ClientSuccess Destination​

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

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

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

    ClientSuccess destinations can also be configured manually, allowing you to send data to ClientSuccess 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 ClientSuccess endpoints. Each template is designed specifically for the corresponding ClientSuccess 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.

    Delete Contact

    This endpoint deletes a contact from ClientSuccess by its UUID. Use it to remove contacts that are no longer valid, keeping your customer success data clean and current.

    • Enter the UUID of the contact to delete in the Contact ID field. This value is required and is appended to the request URL to target the specific contact to be removed.
    • The contact UUID is typically supplied from the incoming Nexset data. Map the field in your Nexset that holds the contact UUID to the Contact ID parameter.

    Contact deletion is permanent. Verify that the UUIDs being sent correspond to the contacts you intend to remove before activating the destination.

Configure Manually​

ClientSuccess destinations can be manually configured to send data to any valid ClientSuccess API endpoint. This is useful for write operations not covered by the pre-built template, such as creating clients, contacts, contracts, or client notes, or for applying custom request configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the ClientSuccess 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 ClientSuccess API from the Method pulldown menu. ClientSuccess write operations commonly use POST to create records, PUT to fully replace records, PATCH to partially update records, and DELETE to remove records.

Data Format​

  1. Select the format in which the Nexset data will be sent to the ClientSuccess API from the Content Format pulldown menu. ClientSuccess endpoints accept JSON, so select the 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 ClientSuccess API endpoint to which you want to send the Nexset data in the URL field—for example, https://api.clientsuccess.com/api/v1/contact. For update, patch, or delete operations, include the ID of the object to be modified at the end of the URL (e.g., https://api.clientsuccess.com/api/v1/contact/{contact_id}).

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 any headers already present in the credentials. The ClientSuccess X-API-Key authentication header is handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this ClientSuccess 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. This is useful for the ClientSuccess bulk and upsert endpoints, which accept multiple records in a single request.

  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.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the ClientSuccess 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, such as the IDs of newly created clients, contacts, or contracts.

  • 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 ClientSuccess 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 ClientSuccess 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 ClientSuccess 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 ClientSuccess, open the destination resource menu, and select Activate.

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