Gainsight® NXTCS

Gainsight integrates with Salesforce and uses the sales data, surveys, support tickets, usage logs, and other sources of customer intelligence to turn customer retention into an automated, data-driven process.

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 - The Submit Bulk Job API is used to submit the bulk job request to download the data from Gainsight custom object.

  • Bulk API Job Status - The Bulk API Job Status API is used to check the job status of the Bulk API.

  • Fetch Chunk Data - The Fetch Chunk Data API is used to download large amounts of data in chunks (multiple files).

Customer Goals APIs

  • Create Customer Goals - The Create Customer Goals API lets you create new goals.

  • Update Customer Goals - The Update Customer Goals API lets you update the goal details such as associating or removing the association with CTAs and Success Plans.

  • Fetch Customer Goals - The Fetch Customer Goals API helps you retrieve goals along with their details.

Data Management APIs

  • Get Describe OMD - The Get Describe OMD API retrieves the Object details and the related Object details such as ObjectName, label, objectType, labelPlural, and keyPrefix.

  • Post Describe OMD - The Post Describe OMD API is used to retrieve the specific Objects detail and related Objects detail by filtering the response.

  • Get Lite API Call OMD - The Get Lite API Call OMD API is used to retrieve the list of Objects with the minimum metadata information.

  • Post Lite API Call OMD - The Post Lite API Call OMD API is used to retrieve the specific list of Objects with the minimum metadata information by filtering the required Objects.

Timeline APIs

  • Single Activity Save API - The Single Activity Save API helps you save an Activity to Timeline.

  • Bulk Activity Save API - The Bulk Activity Save API helps you save multiple Activities to Timeline. Maximum allowed size of the payload is 80 MB.

  • Get Status API - The Get Status API helps you check the status of submitted bulk records.

  • Single Update API - The Single Update API updates a single activity provided in the request body. The record can either be identified by externalId or by activityId.

  • Bulk Update API - The Bulk Update API updates activities listed in the request body. The records can either be identified by externalId or by activityId.

  • Delete API - The Delete API deletes activities listed in the request body. The records will be identified by activityId.

  • Fetch Deleted - The Fetch Deleted API helps you retrieve the list of deleted Activities in the given timestamp range.

  • Read Activity - The Read Activity API lets you read the inserted activity record details.

  • Abort Bulk Jobs - The Abort Bulk Jobs API helps you abort the submitted bulk insert/update records job.

User Management APIs

  • Create Users: The Create Users API is used to create users in Gainsight.

  • Update Users: The Update Users API is used to update user details in Gainsight.

  • Update Users Status: The Update Users Status API is used to update the status (active/inactive) of the users in Gainsight.

  • Fetch User Details: The Fetch User Details API is used to get the details of the users in Gainsight.

Cockpit APIs

  • Call to Action

    • Create Call To Action: The Create Call To Action API creates a new Call To Action in Gainsight.

    • Update Call To Action: The Update Call To Action API updates existing Call To Action in Gainsight.

    • Fetch Call To Action: The Fetch Call To Action API is used to fetch Call To Action in Gainsight.

    • Get Call To Action Configuration: The Get Call To Action Configuration API retrieves the configuration for the Call To Action Type, Reason, Status, and Priority.

  • Task and Playbook API

    • Create Task API: The Create Task API creates a new CSTask in Gainsight.

    • Update Task API: The Update Task API updates an existing CSTask in Gainsight.

    • Fetch Task List API: The Fetch Task List API is used to fetch the list of Tasks in Gainsight.

    • Get Playbook Configuration API: The Get Playbook Configuration API retrieves the list of all the Playbook configurations.

Success Plan APIs

  • Create Success Plan: The Create Success Plan API allows admin to create a new Success Plan in Gainsight.

  • Update Success Plan: The Update Success Plan API updates the existing Success Plan in Gainsight.

  • Get Success Plan Configurations: The Get Success Plan Configurations API retrieves the configuration for the Success Plan Type, Status, and Objective Categories.

  • Fetch Success Plan List: The Fetch Success Plan List API 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 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 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 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 from tenant to tenant: Actual fields listed in the operation may vary from those in the Gainsight documentation, as the list of fields is populated based on a specific tenant.

  • Mandatory and optional fields: There are instances where certain fields does not behave according to the specification. Behavior of the mandatory and optional fields may conflict with their schema.

  • Data types support: Gainsight does not support the "string array" data type in their tenant.

  • API request body reference: Sample requests in Gainsight documentation can not be considered as reference. Refer to the UI to see the actual fields and their values.