Skip to main content
Gainsight Inc.

Use Custom Event API

This article explains how to use the Custom Event API.

Overview

Gainsight PX Web SDK supports the ability to send custom events via API. Trigger an API call to create a custom event using the name for the custom event as well as properties/values for that event.

The following types are supported:

  • string
  • number
  • boolean
  • datetime (ISO 8601 UTC date and time)
  • nested objects that are saved as a string

Here is an example call:

// Tracking examples with event properties

aptrinsic('track', 'Video', {"name":"Welcome Video","Category":"Onboarding","Length" :5000 ,"Launched" : true , "Launched date":"2018-03-08T18:11:00Z" }); 

// Track search
aptrinsic('track', 'Search', {"terms":"profile setting how-to","results":10,"Category":"Admin"}); 

//

Also, in the example above the custom event includes property/values for the custom event (name, Audience size, Launched, etc), your custom event would, of course, have properties specific to your custom event. 

Note:

Custom Event properties are case sensitive. For example, the event property of name can be sent as "Name" or "name".

Custom Event Limits

Type Limit (standard edition)
Event Names 2000
Length or property value 1024 characters
  • Was this article helpful?