Retently Destination

The Retently destination allows you to send transactional surveys when an event is triggered in Segment.

It takes only three steps to set everything up and start surveying your audience:

1. From the Destinations catalog page in the Segment App, click "Add Destination".
2. Search for "Retently" in the Destinations Catalog, and select the "Retently" destination.
3. Choose which Source should send data to the "Retently" destination.

1. In Retently, go to the API token page.
2. Give the API key a name and click "Create".
3. Copy the API key and enter it in the "API key" section, on the Retently destination settings page.

1. In the Retently destination settings in the Segment app, go to the Map Retently campaigns with Segment events section.
2. In the left input field, enter the ID of the survey campaign. Learn how to configure the survey campaign.
3. In the right field, list the name of one or more Segment Track events that should trigger the survey in the specified campaign. Write the name of the event exactly as it's written in the analytics.track method (more details in the section below). You can enter multiple Track events by separating them with a comma symbol (for example Order Placed, Dashboard Visited).

Save your changes to activate the Retently destination. After you complete these steps, Retently sends a survey in your transactional campaign every time one of the specified Track events is triggered in Segment.

When a Segment Track event fires, Retently performs the following actions:

1. Identifies the Track event name, and attempts to match it with the campaign ID from the Retently destination settings in Segment. If no campaign ID lists this track event name, then Retently dismisses the event.
2. If the Track event name matches a campaign ID, Retently looks for the properties object passed with the track event, and creates a new customer record in Retently using the properties listed in the object.

The only property that Retently requires is email. All other properties can be assigned as optional customer properties in Retently. To learn how to manage customer properties using Segment track events see the Retently documentation.

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:

1
analytics.track('Subscription Activate Button Clicked', {
2
    email: "john.doe@example.com",
3
    firstName: "John",
4
    lastName: "Doe",
5
    companyName: "ACME",
6
    tags: "foo, bar, baz",
7
    subscription_name: "Professional",
8
    signup_date: "01/30/2020"
9
})

Segment sends Track calls to Retently as a track event.