Stonly Destination

Destination Info

Stonly helps make customers more successful and employees more productive by letting you easily create interactive guides and put them inside and around your website or app – without having to code anything.

This destination is maintained by Stonly. For any issues with the destination, contact their support team.

“Note:” Stonly Destination is currently in beta, which means that they are still actively developing the destination. To join their beta program, or if you have any feedback to help improve Stonly Destination and its documentation, contact Stonly support team!

Getting Started

Before you start, make sure Stonly destination supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

  1. From the Destinations catalog page in the Segment App, click Add Destination.
  2. Search for “Stonly” within the Destinations Catalog, and select Stonly destination.
  3. Choose which Source should send data to Stonly destination.
  4. Log in to your Stonly account and go to Team Management.
  5. Select “Integrations” in left navigation and copy Stonly API key.
  6. Enter the “API Key” in Stonly destination settings in Segment.


If you’re not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like this Identify method documentation to learn about what it does. An example call would look like:

analytics.identify("userId", {
  email: ""

Segment sends Identify calls to Stonly as an identify event.

Stonly uses strong typing for user traits thus all the traits are converted to matching type.

Following types are supported:

  • boolean
  • number
  • string
  • date

If one of your traits is of the date property type it should be sent as an ISO string.


If you aren’t familiar with the Segment Spec, take a look at the Track method documentation to learn about what it does. An example call would look like:

analytics.track("TicketCreated", {
  ticketId: 123,
  creationDate: "2020-05-30T10:03:06.716Z"

Segment sends Track calls to Stonly as a track event.

If one of your properties is of the date property type, it should be sent as an ISO string.


Nested Objects and Arrays

Stonly does not accept nested properties or arrays, so such properties will be flattened and stringified. Stringified properties names are period delimited. For example:

analytics.track("AddedToBasket", {
  metadata: {
    content: {
      productCode: 462,
      price: 847.63,
      attributes: [{ size: "M" }, { color: "red" }]

The resulting set of properties will look as:

'metadata.content.productCode': 462,
'metadata.content.price': 847.63,
'metadata.content.attributes.0.size': 'M',
'metadata.content.attributes.1.color': 'red'


You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Real-time to batch destination sync frequency

Real-time audience syncs to Stonly may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
string. Check out this Stonly guide on how to get your API key.

This page was last modified: 25 Apr 2022

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
Create free account