Gainsight® NXTCS
Gainsight works with Salesforce to use sales data, surveys, support tickets, and usage logs to make customer retention easier and more automated.
Connector Version - 10.7
API Versions - nxt (6.34)
API Types - REST
Authentication and Authorization - Custom API-key and OAuth 2.0
Prerequisites - Gainsight credentials and a tenant
Custom Actions
Bulk REST APIs
-
Submit Bulk Job - Submits the bulk job request to download the data from Gainsight custom object.
-
Bulk API Job Status - Checks the job status of the Bulk API.
-
Fetch Chunk Data - Downloads large amounts of data in chunks (multiple files).
Customer Goals APIs
- Create Customer Goals - Creates new goals.
- Update Customer Goals - Updates the goal details such as associating or removing the association with CTAs and Success Plans.
- Fetch Customer Goals - Retrieves goals along with their details.
Data Management APIs
-
Get Describe OMD - Retrieves the Object details and the related Object details such as ObjectName, label, objectType, labelPlural, and keyPrefix.
-
Post Describe OMD - Retrieves the specific Objects detail and related Objects detail by filtering the response.
-
Get Lite API Call OMD - Retrieves the list of Objects with the minimum metadata information.
-
Post Lite API Call OMD - Retrieves the specific list of Objects with the minimum metadata information by filtering the required Objects.
Timeline APIs
-
Single Activity Save API - Saves an Activity to the timeline.
-
Bulk Activity Save API - Saves multiple Activities to a timeline. The maximum allowed size of the payload is 80 MB.
-
Get Status API - Checks the status of submitted bulk records.
-
Single Update API - Updates a single activity that is provided in the request body. The activity can be identified using either externalId or activityId.
-
Bulk Update API - Updates multiple activities that are specified in the request body. Each activity can be identified by either externalId or activityId.
-
Delete API - The Delete API deletes activities that are listed in the request body. Each record must be identified by activityId.
-
Fetch Deleted - The Fetch Deleted API helps you retrieve the list of deleted Activities in the specified timestamp range.
-
Read Activity - Reads the inserted activity record details.
-
Abort Bulk Jobs - Aborts the submitted bulk insert or update records job.
User Management APIs
-
Create Users - Creates users in Gainsight.
-
Update Users - Updates user details in Gainsight.
-
Update Users Status - Updates the status (active or inactive) of the users in Gainsight.
-
Fetch User Details - Retrieves the details of the users in Gainsight.
Cockpit APIs
-
Call to Action
-
Create Call To Action - Creates a Call To Action in Gainsight.
-
Update Call To Action - Updates existing Call To Action in Gainsight.
-
Fetch Call To Action - Retrieves Call To Action in Gainsight.
-
Get Call To Action Configuration - Retrieves the configuration for the Call To Action, Reason, Status, and Priority.
-
-
Task and Playbook API
-
Create Task API - Creates a new CSTask in Gainsight.
-
Update Task API - Updates an existing CSTask in Gainsight.
-
Fetch Task List API - Fetches the list of Tasks in Gainsight.
-
Get Playbook Configuration API - Retrieves the list of all the Playbook configurations.
-
Success Plan APIs
-
Create a Success Plan - Creates a Success Plan in Gainsight.
-
Update Success Plan - Updates the existing Success Plan in Gainsight.
-
Get Success Plan Configurations - Retrieves the configuration for the Success Plan Type, Status, and Objective Categories.
-
Fetch Success Plan List - Retrieves the Success Plans data available in your Gainsight org.
Additional Information
Doctype lookup is enabled for the following services:
| Service Name | Action Name | Doctype Lookup |
|---|---|---|
| Bulk REST APIs | Not Available | Not Available |
| Cockpit APIs - Call to Action |
Create a Call To Action Update Call To Action Fetch Call To Action Get CTA Configuration |
Yes Yes No No |
| Cockpit APIs - Task and Playbook API |
Create Task API Update Task API Fetch Task List API Get Playbook Configuration API |
Yes Yes No No |
| Success Plan APIs |
Create a Success Plan Fetch Success Plan List Update Success Plan Get Success Plan Configurations |
Yes No Yes No |
| Customer Goals APIs |
Create Customer Goals Update Customer Goals Fetch Customer Goals |
Yes No No |
| Data Management APIs |
Get Describe OMD Post Describe OMD Get Lite API Call OMD Post Lite API Call OMD |
No No Yes No |
| Timeline APIs |
Single Activity Save API Bulk Activity Save API Get Status API Single Update API Bulk Update API Delete API Fetch Deleted Read Activity Abort Bulk Jobs |
Yes Yes No Yes Yes No No No No |
| User Management APIs |
Create Users Update Users Update Users Status Fetch User Details |
Yes Yes No No |
Limitations
-
Fields vary by tenant – The fields shown that in the operation may differ from those in the Gainsight documentation, as they are dynamically generated based on each tenant’s configuration.
Mandatory and optional fields – Sometimes, fields may not behave as defined in the schema. The actual behavior of mandatory and optional fields may conflict with the documentation.
Data type support – Gainsight does not support the string array data type within tenant configurations.
API request body reference – Sample requests in the Gainsight documentation should not be used as definitive references. Refer to the user interface to view the actual fields and their valid values.