Give a name to the destination and click on Next. You should then see the following screen:
Delighted Connection Settings
Enter your Delighted API Key.
For more information on how to get your Delighted API key, refer to the Delighted docs.
By default, the channel is set to Email. You can also select SMS from the dropdown.
Set the Delay value (in seconds) here. By default it is set to 0.
To make a track call, enter the Event Names for which track call will be triggered.
If the RudderStack dashboard does not contain the Event for which the track call is triggered, RudderStack will throw an error.
Finally, click on Next. Delighted will now be enabled as a destination in Rudderstack.
The identify call lets you to add a user to your PeopleList. If the user already exists, RudderStack will update the user with the latest information. This includes userId as well as other additional properties related to user like name,phone number/email, channel, and the 'Last sent at' timestamp.
The userId provided during the call must match the Channel type. The channel type can be either set from Rudderstack dashboard or you can send it via the identify call with the parameter DelightedChannelType.
The channel type set via the identify call will get a higher precedence.
You can provide the user email or phone number. Both are not required at the same time, since one of the values will be set from the userId.
You can also send the last_sent_at value with the call. Refer to the example below for more details.
Last sent at (in UNIX timestamp) is used to manually set the time a person was most recently sent a survey. This value will be used in the Delighted Survey throttling system, which ensures that same person won’t be surveyed more than once per month.
To change its value manually, go the Delighted dashboard, select your Project from top left corner and click on the settings icon beside Project Name.
In this example, since the userId is already an email, you can provide the user's phone_number as well. Also, the delightedChannelType will override the Channel Type set in the RudderStack dashboard.
Except userId, all the other fields in the call are optional.
The track call lets you send the survey to the user added to the PeopleList in your account. In addition to name, phone number/email,channel, and the 'Last sent at' timestamp, you can also add as many custom properties as you need.
If the user does not exist, you cannot make a track call. You need to first add the user in the People list via the identify call.
The Delay value from the dashboard will override the value sent via the track call.
A sample track call is as shown below:
delighted_email_subject:"Custom Email Subject.",
In the above example, Test is the event name. Except the event name, all other fields are optional.
If you do not enter the Event name in the dashboard for which the track call is triggered, RudderStack will throw an error.
Delighted also provides some custom properties by itself. In the above example, delighted_email_subject sets the email subject of the survey to Custom Email Subject. Note that this change can be done from the Delighted website too.
Some other default properties provided by Delighted are mentioned in the table below:
Delighted shows this question in the survey.
Delighted displays this message in the email subject.
This property determines the localization (including language) of the survey experience.
For more default properties, check out this Delighted support page.
In the example shown above, customProperty is the custom property field that you can set. Note that you must provide values for these custom fields, or else they will be dropped by Delighted.
The alias call allows you to update the user's email or phone number. You need to set previousId as the current value and userId as the updated value.
The previousId and userId must be of the same type, i.e., either email or phone number.