# Usertick

> Usertick documentation. Surveys, in-product feedback and reporting in one tool.

- [Welcome to Usertick](https://docs.usertick.com/index.md): Usertick runs surveys on your website, by link, by QR code and by email, and collects every response in one inbox with reports and integrations.
- [Quickstart](https://docs.usertick.com/quickstart.md): Create an account, add your site, publish a first website survey and read the first response.
- [Core concepts](https://docs.usertick.com/concepts.md): The five terms the rest of the docs use: organization, site, survey, response and member.
- [Keyboard shortcuts](https://docs.usertick.com/keyboard-shortcuts.md): Open the search and the AI Assistant, jump between sections, search a list, work through the inbox, publish a survey and edit a workflow from the keyboard.
- [Install on your website](https://docs.usertick.com/installation/website.md): Add the Usertick script tag to a site, check the install and see how the widget behaves on the page.
- [Platform guides](https://docs.usertick.com/installation/platforms.md): Add the Usertick tag on WordPress, Shopify, Webflow, Wix, Squarespace and other website builders, stores and tag managers, step by step.
- [Install with npm](https://docs.usertick.com/installation/npm.md): Install the @usertick/snippet package and initialize it in React, Next.js, Vue, Nuxt, Angular, Svelte, Astro, Remix, Gatsby or any app with a bundler.
- [Identify your users](https://docs.usertick.com/installation/identify.md): Send your user ID and traits with each response, prove them with a hash from your server, and link responses to contacts.
- [Verify your users](https://docs.usertick.com/installation/verify-users.md): Prove that the user ID your page sends is genuine, with a hash your server computes once per user.
- [Cookies and consent](https://docs.usertick.com/installation/cookies-and-consent.md): Every cookie and storage key the Usertick widget and hosted survey pages keep in a visitor's browser, and how to load the widget only after a visitor consents.
- [Troubleshooting](https://docs.usertick.com/installation/troubleshooting.md): Find out why a website survey doesn't appear, with checks in the order that finds the cause fastest.
- [Create a survey](https://docs.usertick.com/surveys/create.md): Start a survey with AI, from questions you already have, from a template or from a blank survey, and follow its status from draft to archived.
- [The editor](https://docs.usertick.com/surveys/editor.md): How the survey editor is organized, how drafts are saved and published, and how the live preview and editing locks work.
- [Question types](https://docs.usertick.com/surveys/question-types.md): The 25 question types, what each one is for and the options it offers. File upload, screenshot and signature questions need the Starter plan; every other type is on every plan.
- [Logic and branching](https://docs.usertick.com/surveys/logic.md): Send respondents to different questions based on their answers, without code. Rules run on the respondent's device in step-by-step and chat surveys.
- [Design and branding](https://docs.usertick.com/surveys/design.md): Set how a survey displays (popup, side button, embedded, page template, steps and controls) and style it with a theme your whole organization shares.
- [Targeting](https://docs.usertick.com/surveys/targeting.md): Decide who can see a website survey: pages, devices, country, visitor type, sign-in state and traits, earlier surveys, referrer, campaign parameters, traffic share, availability and response limits.
- [Triggers](https://docs.usertick.com/surveys/triggers.md): When a website survey opens: smart triggers for frustration, finished reading, engagement, hesitation and searching, page load, delay, scroll, exit intent, clicks, forms, copied text, videos, custom events and more, and how often it returns.
- [Templates](https://docs.usertick.com/surveys/templates.md): More than 300 ready-made surveys for common moments and industries, each with its questions, wording and theme.
- [Languages](https://docs.usertick.com/surveys/languages.md): Run one survey in several languages, with each visitor seeing their own language automatically.
- [Website surveys](https://docs.usertick.com/channels/website.md): Show surveys on your own site as a popup, a side button or an embedded survey, using the site's install code.
- [Link surveys](https://docs.usertick.com/channels/link.md): Share a survey as a page hosted by Usertick, with its own address, no website and no install.
- [QR code surveys](https://docs.usertick.com/channels/qr.md): Print a survey's link as a QR code for receipts, packaging, posters, tables and events.
- [Email surveys](https://docs.usertick.com/channels/email.md): Design a survey email, send it to your contacts through Usertick or your own email provider, and follow each send.
- [Results](https://docs.usertick.com/results/overview.md): A survey's Results page: the key numbers, an AI reading of each period, every question broken down, who answered and how variants compare.
- [The inbox](https://docs.usertick.com/results/inbox.md): Read every response from every channel in one list, filter it by status, type, category, theme and urgency, and assign, discuss or file responses in Jira or Linear.
- [How responses are read](https://docs.usertick.com/results/analysis.md): What each reading on a response means, how to correct one, and how to change the categories responses are filed under.
- [Dashboards](https://docs.usertick.com/results/dashboards.md): Build dashboards from cards: numbers, charts, breakdowns and lists, filtered by date and audience, shared and exported.
- [Metrics](https://docs.usertick.com/results/metrics.md): How Usertick calculates NPS, CSAT, CES, average score and completion rate.
- [Exports and reports](https://docs.usertick.com/results/exports.md): Export results and dashboards as PDF, Excel or CSV, export one response from the inbox, and send a survey or a dashboard as a scheduled PDF report by email or to a Slack or Microsoft Teams channel.
- [Workflows](https://docs.usertick.com/workflows/overview.md): Act on a survey's responses as they arrive: post them to Slack or Microsoft Teams, file issues, update records, notify teammates or watch a number, with a flow of steps you draw on a canvas.
- [Organization settings](https://docs.usertick.com/workspace/organization.md): Switch between organizations, change the name and logo, pause collection for the whole organization, and see who owns it.
- [Members and roles](https://docs.usertick.com/workspace/members-and-roles.md): Invite your team, control what each person can do and which surveys they open with roles and permissions, transfer ownership and review the activity log.
- [Sharing](https://docs.usertick.com/workspace/sharing.md): Share a dashboard with the whole organization or with specific people, and control who can edit it.
- [Notifications](https://docs.usertick.com/workspace/notifications.md): The notification bell, and how to choose what reaches you in the dashboard, on your desktop, by email, in Slack and in Microsoft Teams.
- [Security and sign-in](https://docs.usertick.com/workspace/security.md): Sign-in, email codes, two-factor authentication, signed-in devices, accounts managed through single sign-on and where your data is stored.
- [Single sign-on and SCIM](https://docs.usertick.com/workspace/single-sign-on.md): Sign your team in to Usertick through your identity provider with SAML 2.0, and let the provider add and remove members with SCIM.
- [Sites](https://docs.usertick.com/account/sites.md): Add the domains the widget runs on, install each site's code and check that Usertick finds it.
- [Plans and billing](https://docs.usertick.com/account/billing.md): What each plan includes, how the monthly response limit and extra responses work, how payments go through Stripe, how to upgrade, downgrade or cancel, and what happens after a failed payment, a dispute or a refund.
- [Email sending settings](https://docs.usertick.com/account/email-sending.md): Choose where survey emails are sent from: Usertick, within your plan's monthly allowance, or your own SMTP server, Resend, Mailgun or SendGrid.
- [Help and support](https://docs.usertick.com/account/support.md): Find answers in the in-app help center and the assistant on every plan, and open a support ticket from the Starter plan.
- [Export your data](https://docs.usertick.com/account/data-export.md): Every way to get your organization's data out of Usertick, with its formats and the plans that include it, and how to switch to another provider.
- [Delete your account](https://docs.usertick.com/account/delete-account.md): What happens when you delete your Usertick account, what stays with your organizations, and how to cancel the deletion.
- [Delete an organization](https://docs.usertick.com/account/delete-organization.md): How the owner deletes an organization, what stops right away, how to keep the organization during the 14 days, and what is deleted afterward.
- [Integrations overview](https://docs.usertick.com/integrations/overview.md): Usertick sends new responses to the tools your team already uses, through workflows that act on each survey's responses.
- [Slack](https://docs.usertick.com/integrations/slack.md): Post responses to a Slack channel as cards your team can act on, and send alerts, reports, link previews and personal notifications to Slack.
- [Microsoft Teams](https://docs.usertick.com/integrations/microsoft-teams.md): Post responses to a Teams channel as cards your team can act on, and send alerts, reports and personal notifications to Teams.
- [Linear](https://docs.usertick.com/integrations/linear.md): Create Linear issues from responses with a workflow or by hand, add responses as customer requests, and sync each response with its linked issue.
- [Jira](https://docs.usertick.com/integrations/jira.md): Create Jira Cloud issues from responses with a workflow or by hand, and sync each response with its linked issue.
- [HubSpot](https://docs.usertick.com/integrations/hubspot.md): Sync respondents to HubSpot contacts, create follow-up tasks and send Usertick surveys from HubSpot workflows.
- [Google Sheets](https://docs.usertick.com/integrations/google-sheets.md): Add each response as a row in a Google Sheet, one tab per workflow, and keep the row up to date when the AI analysis or the status changes.
- [Webhooks](https://docs.usertick.com/integrations/webhooks.md): Send responses and account events to your own systems as signed HTTP requests, with retries and a delivery log.
- [Connector catalog](https://docs.usertick.com/integrations/connectors.md): The tools without a guide of their own: what each one does with a response, how it connects and what Usertick sends to it.
- [Google Analytics, FullStory and UXCam](https://docs.usertick.com/integrations/page-events.md): When a visitor completes a survey on your site, the widget sends an event to Google Analytics, FullStory or UXCam through the tool's own script on the page.
- [Zapier](https://docs.usertick.com/integrations/zapier.md): Zaps start from new and analyzed responses, status changes, urgent feedback and workflow steps, and can find, comment on and update responses. In early access, by invite.
- [Tools with Zapier](https://docs.usertick.com/integrations/with-zapier.md): Usertick sends responses to Salesforce, Pipedrive, Notion and 59 more tools that it doesn't connect to natively, from a workflow step or a ready Zap in Zapier.
- [JavaScript SDK](https://docs.usertick.com/developers/sdk/overview.md): The widget's runtime, loaded by a script tag or the @usertick/snippet npm package, and its public methods and events.
- [SDK reference](https://docs.usertick.com/developers/sdk/reference.md): Every method on the Usertick object, with its parameters and behavior.
- [SDK events](https://docs.usertick.com/developers/sdk/events.md): The four widget events, when each one fires and the data it carries.
- [REST API](https://docs.usertick.com/developers/api/overview.md): Read and triage responses, read surveys and metrics, erase personal data, and subscribe to new responses over HTTPS.
- [Authentication](https://docs.usertick.com/developers/api/authentication.md): API keys that belong to your organization, the scopes they carry, expiry, rotation, access changes and usage.
- [OAuth for apps](https://docs.usertick.com/developers/api/oauth.md): How an approved app or an AI assistant connects to Usertick for a person, with the authorization code grant, PKCE, rotating refresh tokens and revocation.
- [The Response resource](https://docs.usertick.com/developers/api/response-object.md): The single shape a response takes outside Usertick, in API reads, in the data of webhook deliveries and in the Zapier app.
- [Pagination](https://docs.usertick.com/developers/api/pagination.md): How lists page with cursors, how big a page can be, and how to keep a copy of your responses in sync.
- [Errors](https://docs.usertick.com/developers/api/errors.md): The error envelope, field errors, every code the REST API returns, and which errors to retry.
- [Rate limits](https://docs.usertick.com/developers/api/rate-limits.md): 120 requests per minute per credential and 600 per organization, the headers that report them, and how to handle a 429.
- [Idempotency](https://docs.usertick.com/developers/api/idempotency.md): An Idempotency-Key on a POST makes a retry after a timeout safe, because Usertick never runs the request twice.
- [Versioning](https://docs.usertick.com/developers/api/versioning.md): What can change within v1, and how a change that removes something is announced.
- [Erase personal data](https://docs.usertick.com/developers/api/erasure.md): Erase one response, or everything one person sent, for a GDPR request. Erasure runs as a background job that you can follow.
- [Metrics](https://docs.usertick.com/developers/api/metrics.md): Response counts, NPS, CSAT, CES and average scores, numbers over time, and breakdowns by the AI's analysis or by where responses came from.
- [Download files](https://docs.usertick.com/developers/api/attachments.md): Download the files respondents sent with their answers through short lived download links.
- [Get the current credential](https://docs.usertick.com/developers/api/reference/get-me.md): The organization, the person an app acts as (none for an API key), the credential itself and its rate limits. Any valid credential may call it, so a connection test never fails on a scope.
- [List surveys](https://docs.usertick.com/developers/api/reference/list-surveys.md): The organization's surveys, newest first. Archived surveys only with status=archived.
- [Get a survey](https://docs.usertick.com/developers/api/reference/get-survey.md): One survey with its published questions (type, required, options, scale), its languages and a settings summary.
- [Pause a survey](https://docs.usertick.com/developers/api/reference/pause-survey.md): Stops showing a published survey and taking its answers until it is resumed. Recorded in the audit log as made through the credential.
- [Resume a survey](https://docs.usertick.com/developers/api/reference/resume-survey.md): Resumes a paused survey. Recorded in the audit log as made through the credential.
- [List sites](https://docs.usertick.com/developers/api/reference/list-sites.md): The organization's sites, connected or not (connected says which), by domain.
- [List responses](https://docs.usertick.com/developers/api/reference/list-responses.md): Every filter of the inbox the API offers, combined, paged by cursor.
- [List recent responses](https://docs.usertick.com/developers/api/reference/list-recent-responses.md): The newest responses in the shape a webhook of the same event carries in data (a trigger's sample). response.created describes each response without its analysis; response.analyzed returns only analyzed ones and response.urgent only those whose urgency reads high, filtered the way a subscription is;…
- [Get a response](https://docs.usertick.com/developers/api/reference/get-response.md): One response, as it is now.
- [Update a response](https://docs.usertick.com/developers/api/reference/update-response.md): Changes the status, type, urgency or assignees (replaced as a whole) through the inbox's own commands, recorded in the audit log as made through the credential. Every field is checked before any is applied. Answers with the response, so it needs responses:read too.
- [List the analysis tree](https://docs.usertick.com/developers/api/reference/list-themes.md): Categories with their themes: the ids responses' ai.theme and ai.category carry and the theme and category filters take. Every plan reads it. One page.
- [List members](https://docs.usertick.com/developers/api/reference/list-members.md): The organization's members, for an assignee picker: their ids are what PATCH /responses/{responseId} takes in assignees. By name (the email when there is none), then email.
- [Download a respondent's file](https://docs.usertick.com/developers/api/reference/get-attachment.md): One of the files the response's answers point at (attachments[].id): 302 to a download link that works for five minutes.
- [List notes](https://docs.usertick.com/developers/api/reference/list-comments.md): A response's notes, oldest first, deleted ones left out.
- [Add a note](https://docs.usertick.com/developers/api/reference/add-comment.md): Adds a note as the credential: an app's note is its member's, an API key's note carries the key's name.
- [Edit a note](https://docs.usertick.com/developers/api/reference/edit-comment.md): Changes a note the credential wrote (an API key its own notes, an app its member's).
- [Delete a note](https://docs.usertick.com/developers/api/reference/delete-comment.md): Deletes a note the credential wrote. The timeline keeps a tombstone; the text is gone.
- [Erase a response](https://docs.usertick.com/developers/api/reference/delete-response.md): GDPR erasure of one response, in the background: its answers, analysis and event, its triage, notes, corrections, stars, assignments, issue links, Microsoft Teams cards, workflow runs and webhook deliveries, and the files its answers point at. 202 with the job.
- [Erase a respondent](https://docs.usertick.com/developers/api/reference/erase-respondent.md): GDPR erasure of every response of one respondent, found by email or by the site's user id. By email: every response with an answer that is exactly the address or whose identify email it is, every one an email survey link sent to the contact with it, every one linked to that contact, and every one se…
- [Get a job](https://docs.usertick.com/developers/api/reference/get-job.md): A background job of the organization and how far it got. A failed run is tried again up to five times.
- [Get summary metrics](https://docs.usertick.com/developers/api/reference/get-metrics-summary.md): Responses over a window (the plan's retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey's first question of its kind.
- [Get a metric over time](https://docs.usertick.com/developers/api/reference/get-metrics-time-series.md): One point per day, week or month (UTC), oldest first.
- [Get a breakdown](https://docs.usertick.com/developers/api/reference/get-metrics-breakdown.md): The analysis (type, urgency, theme, category, sentiment, with people's corrections) or where responses came from (country, device). Largest first. The analysis dimensions answer every value; country and device answer the top largest and fold the rest into other. A response with no value on the dimen…
- [List subscriptions](https://docs.usertick.com/developers/api/reference/list-webhooks.md): The subscriptions this credential made, newest first, without their secrets.
- [Subscribe a URL](https://docs.usertick.com/developers/api/reference/subscribe-webhook.md): A REST hook subscribe: signed deliveries of one event (see webhooks for each one's body), on one survey or every survey, narrowed by the filters the event takes. Event workflow.step instead binds the URL to a workflow's Zapier step (workflowId and stepId, from GET /workflows/zapier-steps): the workf…
- [List workflow Zapier steps](https://docs.usertick.com/developers/api/reference/list-zapier-steps.md): The Zapier steps of the organization's workflows, for a subscription with event workflow.step. A step counts from the moment it is in the workflow's draft, so a Zap can be made before the workflow is published. An app acts as its member, who needs the permission to manage workflows (403 otherwise).…
- [Unsubscribe a URL](https://docs.usertick.com/developers/api/reference/unsubscribe-webhook.md): Deletes a subscription this credential made.
- [List deliveries](https://docs.usertick.com/developers/api/reference/list-deliveries.md): A subscription's delivery log (30 days), newest first.
- [Resend a delivery](https://docs.usertick.com/developers/api/reference/resend-delivery.md): Sends a delivery again: the same body and webhook-id (so the receiver can drop a duplicate), a new timestamp and signature, logged as a new attempt.
- [response.created](https://docs.usertick.com/developers/api/reference/webhook-response-created.md): A response was submitted. data.ai is always null. Answer 2xx within 30 seconds. A failed delivery is retried with backoff (30 s, 2 min, 10 min, 1 h, 6 h); a subscription answered 410 Gone ends.
- [response.analyzed](https://docs.usertick.com/developers/api/reference/webhook-response-analyzed.md): The analysis of a response finished (or was skipped: then data.ai is null). Answer 2xx within 30 seconds. A failed delivery is retried with backoff (30 s, 2 min, 10 min, 1 h, 6 h); a subscription answered 410 Gone ends.
- [response.status_changed](https://docs.usertick.com/developers/api/reference/webhook-response-status-changed.md): A response's status moved: a member in the inbox, a credential through the API, or a linked issue tracker (Jira, Linear: change.by.kind integration). data is the response as it reads now; data.change says from, to and by. Answer 2xx within 30 seconds. A failed delivery is retried with backoff (30 s,…
- [response.classification_corrected](https://docs.usertick.com/developers/api/reference/webhook-response-classification-corrected.md): A member or a credential changed what the analysis says: the type (of the response, or of one answer: change.questionId), the urgency, or an answer's theme or category. change.from and change.to read like data.ai (a value nobody set is the AI's own). A tracker sync's change is not this event. Answer…
- [response.urgent](https://docs.usertick.com/developers/api/reference/webhook-response-urgent.md): A response's urgency became high: the analysis read it high, or a member or a credential set it to high. Once per response and subscription. Answer 2xx within 30 seconds. A failed delivery is retried with backoff (30 s, 2 min, 10 min, 1 h, 6 h); a subscription answered 410 Gone ends.
- [theme.spiking](https://docs.usertick.com/developers/api/reference/webhook-theme-spiking.md): A theme spiked: at least 10 responses in the last 24 hours and at least twice the 24 hours before. Checked hourly; once a day per theme and subscription. Answer 2xx within 30 seconds. A failed delivery is retried with backoff (30 s, 2 min, 10 min, 1 h, 6 h); a subscription answered 410 Gone ends.
- [Webhooks](https://docs.usertick.com/developers/webhooks/overview.md): Signed HTTP deliveries of responses, status changes, AI corrections, urgent feedback, theme spikes and account events to an endpoint you run.
- [Webhook events](https://docs.usertick.com/developers/webhooks/events.md): Every event that can reach your endpoint, who receives it, and the body each one carries.
- [Verify signatures](https://docs.usertick.com/developers/webhooks/verify.md): Check that a delivery came from Usertick before acting on it.
- [Delivery and retries](https://docs.usertick.com/developers/webhooks/delivery.md): Timeouts, the retry schedule, the delivery log, resending, pausing, and what turning off or deleting an endpoint does.
- [Rotate a secret](https://docs.usertick.com/developers/webhooks/rotation.md): Switch a webhook to a new signing secret without missing a delivery.
- [MCP server](https://docs.usertick.com/developers/mcp.md): Connect Claude, ChatGPT, Cursor, VS Code, Claude Code and other AI assistants to Usertick through the Model Context Protocol, with a sign-in.
- [Surveys and channels](https://docs.usertick.com/changelog/surveys.md): Changes to survey building, the editor and the four channels.
- [Dashboard and workspace](https://docs.usertick.com/changelog/dashboard.md): Changes to the dashboard: results, the inbox, access, sharing, notifications, help and security.
- [Integrations](https://docs.usertick.com/changelog/integrations.md): What changed in connecting Usertick to the rest of your stack.
- [Developers](https://docs.usertick.com/changelog/developers.md): Changes to the SDK, the REST API, webhooks and the MCP server.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.