Sending custom event data into FullStory

Method

FS.event(eventName, eventProperties)

Domain-specific events recorded by FullStory add additional intelligence when you're searching across sessions and creating new user segments. You can define and record these events with FullStory custom events.

Parameters

NameDescription
eventNameA string containing the name of the event.
eventPropertiesA JSON object containing additional information about the event that will be indexed by FullStory.

Limits

  • Event names can be no longer than 250 characters.
  • The maximum size of eventProperties is 512Kb.
  • Sustained calls are limited to 30 calls per minute, with a burst limit of 10 calls per second.
  • Arrays of objects will not be indexed (arrays of strings and numbers will be indexed), with the exception of Order Completed events.

Additional Information

Example Invocation

Adding a product to an e-commerce cart
FS.event('Product Added', {
  cart_id_str: '130983678493',
  product_id_str: '798ith22928347',
  sku_str: 'L-100',
  category_str: 'Clothing',
  name_str: 'Button Front Cardigan',
  brand_str: 'Bright & Bold',
  variant_str: 'Blue',
  price_real: 58.99,
  quantity_real: 1,
  coupon_str: '25OFF',
  position_int: 3,
  url_str: 'https://www.example.com/product/path',
  image_url_str: 'https://www.example.com/product/path.jpg'
});
SaaS product subscription
FS.event('Subscribed', {
  uid_str: '750948353',
  plan_name_str: 'Professional',
  plan_price_real: 299,
  plan_users_int: 10,
  days_in_trial_int: 42,
  feature_packs: ['MAPS', 'DEV', 'DATA'],
});