Connect Gainsight CS to Rig

    Sync your Gainsight Customer Success companies, relationships, people, CTAs, success plans and custom objects into Rig, so account health sits with usage and revenue. Gainsight connects with your tenant domain and an M2M OAuth client, or an access key if you prefer.

    Before you start

    • You need a Gainsight admin who can open Connectors 2.0. Creating an access key needs a Super Admin.
    • Know your tenant host, the address you sign in at, such as acme.gainsightcloud.com.
    • Choose a method. An M2M OAuth client is the better choice. An access key does not expire but runs as the user it is bound to.

    Step 1: Create a Gainsight API connection

    Do one of the two options below.

    1. In Gainsight, go to Administration and open Connectors 2.0.
    2. Click Create Connection and choose Gainsight API from the Connector list.
    3. Enter a name for the connection.
    4. For M2M OAuth, choose the M2M OAuth authentication type and generate the client. Copy the client ID and secret it shows.
    5. For an access key, choose the Access_Key authentication type, click Generate Access Key and copy the key.

    Why OAuth is preferred
    An access key reads with the permissions of its bound user. If that user is inactive or unlicensed, every data query fails. The OAuth client does not depend on one person.

    Step 2: Connect it in Rig

    Adding a source needs a workspace owner, or a role with the Manage connections permission, on a workspace where you manage your own connections. If the Connectors tab says “Data ingestion for this workspace is managed by Rig”, ask an owner or Rig support to add the source.

    1. In Rig, open Connections, choose the Connectors tab and go to Sources & actions.
    2. Search for Gainsight CS, open the card and click Connect.
    3. Gainsight domain: enter your tenant host, such as acme.gainsightcloud.com, without https://.
    4. OAuth Client ID (M2M): paste the client ID. Fill this in with the secret, or use the access key instead.
    5. OAuth Client Secret (M2M): paste the client secret that goes with it.
    6. Access Key (alternative to OAuth): only fill this in if you did not create an OAuth client.
    7. Click Continue. Rig checks the credentials and lists the streams it can reach, so choose the ones you want and click Connect.
    8. The source then syncs on its schedule, which is nightly unless you change it. To load data straight away, click Sync on its row; Test pulls a small sample first if you want to check the connection.

    What Rig pulls in

    Gainsight CS lands in its own gainsight schema in your warehouse:

    • Companies, relationships and people: the Gainsight CS records for your customers and the people in them.
    • CTAs and success plans: calls to action and success plans.
    • Custom objects: your own __gc objects, with all their fields.

    The objects come from your own tenant. Rig reads the tenant's schema at sync time, so the list of streams you can choose is discovered when you connect.

    Good to know

    • Gainsight returns up to 5,000 rows per query, so large objects are read in pages and resume if a first sync is interrupted.
    • Objects with a modified date sync incrementally. The others are reloaded in full on every sync.
    • Rig reads Gainsight's delete log on syncs that include an incremental object, which costs extra API calls and marks deleted records.
    • To disconnect Gainsight CS, click the bin icon on the source's row under Sources & actions. Only whoever connected the source or a workspace owner can do this, and data already synced stays in the warehouse.

    What people use this for

    • Test whether health scores predict churn
    • See CS activity against revenue outcomes
    • Bring product usage into the account picture

    More ideas for using Gainsight

    Gainsight CS documentation

    Was this guide helpful?