Introduction

PlatformX allows sending in-the-moment surveys delivered to users through Slack or MS Teams. Surveys are triggered based on specific events, for example: when a user installs your CLI, executes a script, or submits code using a given library.

Creating surveys

To create a survey, browse to the Survey tab within your project and click "Create survey." You will first select the event that you would like to trigger this survey.

Note: If you have not yet sent any events via the API, you will not be able to create and save a survey. Make sure to start sending events from your app then you can select which even you want to start using for gathering feedback.

Then, set a prompt for your survey. You can interpolate event metadata into your survey prompts by referencing the JSON keys in your metadata, for example:

I noticed you just merged <{{pull_url}}|{{repo}}#{{pull_number}}>.

I would love your feedback on how getting your dev environment setup.

Would you be willing to answer these couple quick questions?

Next, you'll choose whether to send surveys from yourself or from a custom Slack Bot. The tradeoffs between these approaches are summarized in the table below. For more help choosing, please contact your DX account representative.

Surveys sent from you	Surveys sent from a bot
Higher response rates Better experience for users Seamless back-and-forth conversation Form questions not required	Less disruptive to you Form questions required

After choosing how to send surveys, you'll be able to configure a number of survey frequency and behavior options:

Delay before sending message. Set a delay to make your survey feel more natural (i.e., not firing instantly after a user performs an action).
Maximum surveys per week. Select a number that is manageable for you and your team to follow up on.
Repeat survey threshold. The window of time that has to pass before the same User gets re-asked for feedback.
Automatic expiration. Close your survey after a certain number of responses have been collected.

Note: DX automatically ensures that people do not receive more than two surveys per week across all PlatformX projects.

Form questions

Form questions are structured input fields that your survey subjects are asked to fill out. Form questions are optional for surveys sent from yourself. If you've chosen to send your survey from a Slack bot, form questions are required.

DX currently supports five types of form questions described below:

Rating scale

A multiple choice question such as CSAT or CES. Values are automatically set to numeric values starting from 1, based on the index of each option.

Multiple choice

A multiple choice question that will be rendered using radio buttons. Options must have labels.

Long text

Textarea field that allows long text responses.

Short text

Text input field for short text responses.

Prequalifier

The prequalifier is the first question shown to users. It determines whether they will see the rest of the survey. Use this to filter participants.

Note: Only one prequalifier is allowed per survey.