Gainsight
Authentication & Authorization
Credentials
-
Gainsight connects via an unique Access Key passing as HTTP header.
-
Access Key can be generated in the Gainsight Dashboard (see the DataGrail Help Docs).
-
Publicly exposing your API credentials can allow unauthorized access to the Gainsight API endpoints, and your Gainsight data by a third party. DataGrail stores your API credentials encrypted and protected.
Permissions
-
Admins can create only one Access Key per org and it does not expire.
-
Gainsight authenticates REST API requests by verifying this access key and if the authentication succeeds, access to Gainsight platform is granted.
Base URL
By default, DataGrail uses Person API which provide the access to Person and Company Person, and Relationship Person objects with base URL:
If you need to manage company-wide communication preferences you additionally need to obtain Gainsight Domain (see DataGrail Help Docs). In that case base URL will be based on your Gainsight Domain:
-
https://{YOURDOMAIN}/v1
Endpoints Utilized
DataGrail uses the following endpoint to validate that credentials are good based on a successful response:
Version
DataGrail Gainsight integration currently supports API version 1 (v1.0).
Limits
DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
Access
For an access request, DataGrail will take the following actions:
-
By default, with no customer’s Gainsight Domain:
- Call Get Person API with email to get the record from the Person, Company Person, and Relationship Person objects associated with email from the Data Subject provided in the request.
-
If customer has configured Gainsight Domain:
- Call Gainsight Custom Read Object API to read records that match email from the Data Subject provided in the request.
-
For all objects found, DataGrail will return all available fields. You can edit which objects and fields you want to provide to the Data Subject via our Portal Requests.
DataGrail also supports the Direct Contact Access workflow for Gainsight.
Endpoints Utilized
-
By default:
-
With customer’s Gainsight Domain:
- POST https://{YOURDOMAIN}/v1/data/objects/query/Person
Deletion
DataGrail supports the Direct Contact Deletion workflow for Gainsight.
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.