Docs

Surveys

NPS and short surveys shown as a modal or slide-out on matching pages.

A survey asks up to 12 questions. Keep it short: one NPS question with a follow-up gets far more answers than ten questions.

Question types

TypeAnswer
nps0–10: how likely are you to recommend us
ratingA score on a scale, with labels for each end
single_choiceOne option out of up to 10
multi_choiceAny of up to 10 options
textFree text, up to 2,000 characters

A question can be a follow-up: asked only when an earlier answer triggers it. A common setup is an NPS question, then "What should we improve?" for scores below 7.

Show it as a modal or a slide-out, and set a thank-you message.

Results

Results show responses, completion and response rate, the NPS score (promoters, passives and detractors) and each question's answers, including recent free text. Export them as CSV.

Every finished survey also sends a survey.answered webhook, so answers can go straight to your CRM or a channel.

Automate it

  • REST API: /api/surveys, plus /api/surveys/{id}/responses for results. See the API reference.
  • AI agents: create_survey and get_survey_results, or the "Run an NPS survey" prompt. See MCP.

On this page