Gainsight · Schema

Gainsight Call to Action (CTA)

Represents a Call to Action record in Gainsight CS Cockpit, used to drive proactive customer success actions based on risk, opportunity, or lifecycle events.

Properties

Name	Type	Description
Gsid	string	CTA unique identifier
Name	string	CTA name or subject
CompanyId	string	Associated company Gsid
CompanyName	string	Associated company name
TypeId	string	CTA type identifier (e.g., Risk, Opportunity, Lifecycle)
TypeName	string	CTA type display name
ReasonId	string	CTA reason identifier
ReasonName	string	CTA reason display name
PriorityId	string	Priority level identifier
StatusId	string	CTA status identifier
StatusName	string	Status display name
OwnerId	string	Assigned owner user ID
OwnerName	string	Assigned owner name
DueDate	string	Due date for the CTA
ClosedDate	string	Date the CTA was closed
Comments	string	CTA comments or notes
Source	string	Source that triggered the CTA (e.g., Rule, Manual, API)
PlaybookId	string	Associated playbook identifier
CreatedDate	string	Record creation timestamp
ModifiedDate	string	Record last modification timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://www.gainsight.com/schemas/gainsight/cta.json",
  "title": "Gainsight Call to Action (CTA)",
  "description": "Represents a Call to Action record in Gainsight CS Cockpit, used to drive proactive customer success actions based on risk, opportunity, or lifecycle events.",
  "type": "object",
  "required": ["CompanyId", "TypeId", "ReasonId", "PriorityId", "StatusId"],
  "properties": {
    "Gsid": {
      "type": "string",
      "description": "CTA unique identifier"
    },
    "Name": {
      "type": "string",
      "description": "CTA name or subject"
    },
    "CompanyId": {
      "type": "string",
      "description": "Associated company Gsid"
    },
    "CompanyName": {
      "type": "string",
      "description": "Associated company name"
    },
    "TypeId": {
      "type": "string",
      "description": "CTA type identifier (e.g., Risk, Opportunity, Lifecycle)"
    },
    "TypeName": {
      "type": "string",
      "description": "CTA type display name"
    },
    "ReasonId": {
      "type": "string",
      "description": "CTA reason identifier"
    },
    "ReasonName": {
      "type": "string",
      "description": "CTA reason display name"
    },
    "PriorityId": {
      "type": "string",
      "description": "Priority level identifier"
    },
    "StatusId": {
      "type": "string",
      "description": "CTA status identifier"
    },
    "StatusName": {
      "type": "string",
      "description": "Status display name"
    },
    "OwnerId": {
      "type": "string",
      "description": "Assigned owner user ID"
    },
    "OwnerName": {
      "type": "string",
      "description": "Assigned owner name"
    },
    "DueDate": {
      "type": "string",
      "format": "date",
      "description": "Due date for the CTA"
    },
    "ClosedDate": {
      "type": "string",
      "format": "date",
      "description": "Date the CTA was closed"
    },
    "Comments": {
      "type": "string",
      "description": "CTA comments or notes"
    },
    "Source": {
      "type": "string",
      "description": "Source that triggered the CTA (e.g., Rule, Manual, API)"
    },
    "PlaybookId": {
      "type": "string",
      "description": "Associated playbook identifier"
    },
    "CreatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Record creation timestamp"
    },
    "ModifiedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Record last modification timestamp"
    }
  }
}