# Sleekplan

- [Overview](https://sleekplan.com/docs/index.md): Embed a feedback widget, public roadmap, changelog, and CSAT surveys directly inside your app with a single JavaScript snippet
- [Quickstart: Install Sleekplan](https://sleekplan.com/docs/quickstart.md): Add the Sleekplan feedback widget to your app, identify your users, and optionally enable Single Sign-On — all in one short walkthrough
- [Install the JavaScript widget](https://sleekplan.com/docs/install/widget.md): Add the Sleekplan feedback widget to your site with a single script tag, then optionally swap in your own trigger button and notification badges
- [Host on a custom domain](https://sleekplan.com/docs/install/standalone.md): Point a subdomain like feedback.yourcompany.com to Sleekplan, configure the CNAME record, and let Sleekplan handle SSL provisioning automatically
- [Embed in an iframe or webview](https://sleekplan.com/docs/install/iframe.md): Use a parameterized URL to embed Sleekplan inside any iframe or mobile webview, with controls for navigation, layout, and SSO token passing
- [Authentication overview](https://sleekplan.com/docs/authentication/overview.md): Sleekplan supports four authentication mechanisms — JWT SSO for users, API keys for the REST API, OAuth for MCP clients, and secret tokens for webhooks and Canvas
- [Troubleshooting](https://sleekplan.com/docs/troubleshooting.md): Diagnose and fix the most common Sleekplan integration issues — widget not appearing, SSO failures, popup cool-downs, webhook delivery, and Canvas verification
- [JavaScript SDK overview](https://sleekplan.com/docs/sdk/overview.md): Complete reference for the $sleek object: open views, control the launcher and layout, read session state, and wire HTML triggers
- [Configure the SDK](https://sleekplan.com/docs/sdk/configuration.md): Every window global the Sleekplan SDK reads at load time: SLEEK_PRODUCT_ID, SLEEK_USER, SLEEK_SETTINGS, SLEEK_DATA, and SLEEK_COOKIE_DOMAIN, plus how the SDK stores its session
- [Identify and manage users](https://sleekplan.com/docs/sdk/user-setup.md): Pass user identity to Sleekplan with $sleek.setUser(), attach arbitrary metadata, and clear the session on logout so feedback is attributed correctly
- [Listen to SDK events](https://sleekplan.com/docs/sdk/events.md): Use $sleek.on() to react to the widget lifecycle, authentication, navigation, and submissions, with the payload every event carries
- [Show CSAT, NPS, and feedback popups](https://sleekplan.com/docs/sdk/popups.md): Trigger satisfaction and NPS surveys, feedback prompts, and changelog announcements with $sleek.showPopup(), and control which ones appear on their own
- [JWT Single Sign-On](https://sleekplan.com/docs/authentication/single-sign-on.md): Authenticate your existing users into Sleekplan with signed JSON Web Tokens — no separate login required, supported in the widget, embed, and standalone page
- [Sleekplan REST API](https://sleekplan.com/docs/api/overview.md): Read and write feedback, comments, votes, users, changelog entries, surveys, tags, and topics from your own backend over HTTPS
- [REST API keys](https://sleekplan.com/docs/authentication/api-keys.md): Create, use, and rotate API keys for the Sleekplan REST API — generated in Settings → Developer and sent as a Bearer token in every request
- [API v2](https://sleekplan.com/docs/api/v2.md): Authentication, response codes, pagination, and the stability promise for the /v2 namespace
- [List end-users](https://sleekplan.com/api-reference/user/list-end-users.md): Returns a list of your end-users. By default, end-users are sorted by `updated` date with the most recent first.
- [Create an end-user](https://sleekplan.com/api-reference/user/create-an-end-user.md)
- [Retrieve an end-user](https://sleekplan.com/api-reference/user/retrieve-an-end-user.md)
- [Update an end-user](https://sleekplan.com/api-reference/user/update-an-end-user.md): Updates an end-user. Any parameter not provided is left unchanged.
- [Delete an end-user](https://sleekplan.com/api-reference/user/delete-an-end-user.md): Permanently deletes an end-user. Cannot be undone. Anonymizes the user's references (name, metadata, etc.) on all their comments, posts, and survey responses.
- [Get unread notification count](https://sleekplan.com/api-reference/user/get-unread-notification-count.md)
- [List posts](https://sleekplan.com/api-reference/post/list-posts.md): Returns a list of feedback posts. Sorted by trend by default.
- [Create a post](https://sleekplan.com/api-reference/post/create-a-post.md)
- [Retrieve a post](https://sleekplan.com/api-reference/post/retrieve-a-post.md)
- [Update a post](https://sleekplan.com/api-reference/post/update-a-post.md)
- [Delete a post](https://sleekplan.com/api-reference/post/delete-a-post.md): Permanently deletes a post. Cannot be undone.
- [List comments on a post](https://sleekplan.com/api-reference/comment/list-comments-on-a-post.md)
- [Create a comment](https://sleekplan.com/api-reference/comment/create-a-comment.md)
- [Retrieve a comment](https://sleekplan.com/api-reference/comment/retrieve-a-comment.md)
- [Update a comment](https://sleekplan.com/api-reference/comment/update-a-comment.md)
- [Delete a comment](https://sleekplan.com/api-reference/comment/delete-a-comment.md)
- [Like a comment](https://sleekplan.com/api-reference/comment/like-a-comment.md)
- [List votes on a post](https://sleekplan.com/api-reference/vote/list-votes-on-a-post.md)
- [Create or update a vote](https://sleekplan.com/api-reference/vote/create-or-update-a-vote.md)
- [Get post metadata](https://sleekplan.com/api-reference/meta/get-post-metadata.md)
- [Add or update post metadata](https://sleekplan.com/api-reference/meta/add-or-update-post-metadata.md)
- [Remove post metadata key](https://sleekplan.com/api-reference/meta/remove-post-metadata-key.md)
- [List changelog updates](https://sleekplan.com/api-reference/update/list-changelog-updates.md): Returns changelog updates sorted by date, most recent first.
- [Create a changelog update](https://sleekplan.com/api-reference/update/create-a-changelog-update.md)
- [Retrieve a changelog update](https://sleekplan.com/api-reference/update/retrieve-a-changelog-update.md)
- [Update a changelog update](https://sleekplan.com/api-reference/update/update-a-changelog-update.md)
- [Delete a changelog update](https://sleekplan.com/api-reference/update/delete-a-changelog-update.md)
- [List satisfaction responses for an update](https://sleekplan.com/api-reference/update/list-satisfaction-responses-for-an-update.md)
- [Create a satisfaction response for an update](https://sleekplan.com/api-reference/update/create-a-satisfaction-response-for-an-update.md)
- [List satisfaction responses](https://sleekplan.com/api-reference/satisfaction/list-satisfaction-responses.md)
- [Create a satisfaction response](https://sleekplan.com/api-reference/satisfaction/create-a-satisfaction-response.md)
- [List NPS responses](https://sleekplan.com/api-reference/promoter/list-nps-responses.md)
- [Create an NPS response](https://sleekplan.com/api-reference/promoter/create-an-nps-response.md)
- [Send content to the intelligence queue](https://sleekplan.com/api-reference/intelligence/send-content-to-the-intelligence-queue.md)
- [List groups](https://sleekplan.com/api-reference/group/list-groups.md): Returns groups in the workspace. Use `search` to resolve your own identifier to a `group_id`: it matches both the group name and the `data_id` you assigned, partially — searching `acme` also returns `acme-eu`, so compare `data_id` in the response.
- [Create a group](https://sleekplan.com/api-reference/group/create-a-group.md)
- [Retrieve a group](https://sleekplan.com/api-reference/group/retrieve-a-group.md): Counters in `stats` are maintained on a schedule and may lag a change by up to an hour.
- [Update a group](https://sleekplan.com/api-reference/group/update-a-group.md): Partial update — only the fields you send change. The identifier is immutable.
- [Delete a group](https://sleekplan.com/api-reference/group/delete-a-group.md): Removes the group and its memberships. The end-users themselves are not deleted.
- [List a group's members](https://sleekplan.com/api-reference/group/list-a-groups-members.md): Each member carries both `user_id` and the `data_id` you assigned, so you can map your own identifiers to ours.
- [Assign a member to a group](https://sleekplan.com/api-reference/group/assign-a-member-to-a-group.md): An end-user may belong to several groups. Assigning an existing member again succeeds without duplicating.
- [Unassign a member from a group](https://sleekplan.com/api-reference/group/unassign-a-member-from-a-group.md): Removes the membership only. The end-user is not deleted.
- [List documents](https://sleekplan.com/api-reference/document/list-documents.md): Returns documents in the workspace, newest change first. Use `search` to resolve a document you did not create through the API into a `document_id`: it matches the title.
- [Create a document](https://sleekplan.com/api-reference/document/create-a-document.md): Creates a document and records version 1, so its history is complete from the start.
- [Retrieve a document](https://sleekplan.com/api-reference/document/retrieve-a-document.md): The only endpoint that returns `content`.
- [Update a document](https://sleekplan.com/api-reference/document/update-a-document.md): A partial update — a field you omit keeps its stored value, and `content: null` clears it.
- [Delete a document](https://sleekplan.com/api-reference/document/delete-a-document.md): ⚠️ Deletes the document **and its entire version history**, along with its feedback links and shares. There is no undo and no soft delete.
- [Webhooks](https://sleekplan.com/docs/webhooks.md): Subscribe to real-time HTTP POST notifications when feedback, votes, comments, or changelog entries change in your Sleekplan workspace
- [Canvas overview](https://sleekplan.com/docs/canvas/overview.md): Canvas lets your integration render interactive UI inside the Sleekplan admin — the request/response loop, available views, and the X-Secret verification model
- [Install the Custom Integration](https://sleekplan.com/docs/canvas/install.md): Configure your Canvas URL, secret token, optional webhook, and section in Sleekplan Admin so your integration starts rendering inside feedback posts
- [Canvas component reference](https://sleekplan.com/docs/canvas/components.md): Every component type Canvas can render — text, button, input, dropdown, list, link, divider — with props, interaction payloads, and conditional visibility
- [Canvas examples](https://sleekplan.com/docs/canvas/examples.md): Working Node.js and PHP endpoints that handle the initial render, search-or-create flow, X-Secret verification, and confirmation state
- [MCP Server](https://sleekplan.com/docs/mcp-server.md): Give Claude, Cursor, Windsurf, VS Code, and any MCP-compatible AI client direct access to your Sleekplan workspace via Streamable HTTP and OAuth 2.1
- [Home](https://sleekplan.com/help/index.md): Find answers about your workspace, integrations, product guides, and policies—all in one place.
- [Core concept](https://sleekplan.com/help/getting-started/index.md): A plain-English tour of how Sleekplan works, its modules, and how Sleek Intelligence collects, organizes, and acts on your feedback.
- [Install the Sleekplan widget](https://sleekplan.com/help/getting-started/install-widget/index.md): Add the Sleekplan feedback widget to your website by pasting one script snippet, then identify your logged-in users so their feedback, votes, and comments are attributed correctly.
- [Install Sleekplan with React](https://sleekplan.com/help/getting-started/install-widget/react.md): Load the Sleekplan feedback widget in a React app by injecting the install snippet from a useEffect hook, with notes for class components and Next.js.
- [Install Sleekplan with Vue](https://sleekplan.com/help/getting-started/install-widget/vue.md): Add the Sleekplan feedback widget to a Vue app, either by pasting the snippet into index.html or by injecting it from your root component's mounted hook.
- [Add Sleekplan to Webflow](https://sleekplan.com/help/getting-started/install-widget/webflow.md): Add the Sleekplan feedback widget to a Webflow site by pasting the install snippet into your project's custom code and republishing.
- [Use the widget with a Content Security Policy](https://sleekplan.com/help/getting-started/install-widget/content-security-policy.md): The Content Security Policy directives and Sleekplan domains you need to allowlist so the feedback widget loads, styles, and connects correctly on a site that enforces a CSP.
- [Get help and contact support](https://sleekplan.com/help/getting-started/get-help.md): Three ways to get help with Sleekplan. Ask Sleekmate, open the Help & support center in your dashboard to report a bug, suggest a feature or chat with us, or email support@sleekplan.com.
- [Modules](https://sleekplan.com/help/modules/index.md): Learn how to use Sleekplan's modules to collect feedback and engage your users.
- [Create a post](https://sleekplan.com/help/feedback/create-post.md): Add a feedback post from the admin dashboard: write with Markdown, post on behalf of a user, attach files, and set status, category, precedence, owner, and estimate.
- [Comments and internal discussions](https://sleekplan.com/help/feedback/comments.md): Reply to feedback, keep team-only private notes, mention teammates, attach images, and like, pin, edit, or delete comments.
- [Merge duplicate feedback](https://sleekplan.com/help/feedback/merge-feedback.md): Combine duplicate posts into one so votes, subscribers, and comments add up in a single place. Learn how to merge posts, pick which one survives, and what unmerging does (and doesn't) undo.
- [Vote on behalf of a user](https://sleekplan.com/help/feedback/vote-on-behalf.md): Add a customer's upvote to a feedback post from the admin dashboard: search for the user or add them by email, keep vote counts accurate, and see who has voted.
- [Allow more attachment file types](https://sleekplan.com/help/feedback/attachment-file-types.md): By default your users can only attach images to feedback posts and comments. Turn on custom file types to also accept documents, spreadsheets, and other formats, while dangerous file types stay blocked.
- [Categories, components, tags, and statuses](https://sleekplan.com/help/feedback/organizing-feedback.md): Statuses, categories, components, and tags each organize feedback in a different way. Learn what each is for, which axis belongs where, and see real setups for single-product SaaS, multi-product companies, agencies, game studios, and more.
- [Impact Score](https://sleekplan.com/help/feedback/impact-score.md): Rank feedback by real impact instead of raw vote counts, and tune the weights so the score reflects how your team actually prioritizes.
- [Post insights](https://sleekplan.com/help/feedback/post-insights.md): Open the Insights tab on any feedback post to see how demand is trending, which companies and revenue sit behind the request, how urgent voters think it is, and what the comments sound like.
- [Revenue behind a request (MRR)](https://sleekplan.com/help/feedback/revenue-mrr.md): Record MRR on individual customers, on companies, or on both, and read the combined revenue behind every feedback post.
- [Add, remove, and reorder statuses](https://sleekplan.com/help/feedback/statuses.md): Statuses track a feedback post through your workflow. Create your own statuses, choose which appear on the roadmap, reorder them, and delete the ones you no longer use.
- [Internal statuses](https://sleekplan.com/help/feedback/internal-statuses.md): Mark a status internal so only your team sees it. Every public surface shows a public reference status in its place, so you can track work in detail without changing what you promise your customers.
- [Add, remove, and reorder categories](https://sleekplan.com/help/feedback/categories.md): Categories group your feedback posts by type, such as Feature, Bug, or Improvement. Create your own categories, choose where each is available, control voting and visibility, reorder them, and delete the ones you no longer use.
- [Category templates](https://sleekplan.com/help/feedback/category-templates.md): Give each feedback category a starting body that prefills the post composer, so users submit structured, complete feedback. Set a template per category, or a Default template that applies everywhere else.
- [Hide posts from your public board](https://sleekplan.com/help/feedback/hide-posts.md): Keep feedback internal. Hidden categories take a post off your public board and roadmap, block direct links to it, and let your team keep working on it in the dashboard.
- [Show a category to only some of your customers](https://sleekplan.com/help/feedback/segment-categories.md): Scope a category to a segment so only matching customers see its posts. Use it for employee-only boards, beta groups, or categories that only paying customers can reach.
- [Add, remove, and reorder components](https://sleekplan.com/help/feedback/components.md): A component says which part of your product a post is about, such as Widget, API, or Billing. Create components, scope them to an audience, reorder them, and delete the ones you no longer need.
- [Add and remove tags](https://sleekplan.com/help/feedback/tags.md): Tags are lightweight internal labels you attach to feedback posts for filtering and triage. Create the tags your team needs and delete the ones you no longer use.
- [Filter, sort, and search feedback](https://sleekplan.com/help/feedback/filters.md): Find the right posts on your feedback board: switch views, filter by status, category, labels, owner, segment, votes, and dates, sort the list, and save reusable views.
- [Bulk edit feedback](https://sleekplan.com/help/feedback/bulk-actions.md): Select multiple posts on the feedback list and update them all at once: change status, category, labels, or precedence, or delete posts in bulk.
- [Views and the sidebar](https://sleekplan.com/help/feedback/views.md): Save a set of feedback filters as a reusable view, pin it to the sidebar, and reopen your frequent filters in one click. Share views with your team and manage them from the command palette.
- [Documents](https://sleekplan.com/help/documents/index.md): Documents hold the thinking behind your feedback: the research, the decision, and the reasoning. Learn what a document is in Sleekplan, how the Documents screen is organized, and how documents relate to feedback posts.
- [Write a document](https://sleekplan.com/help/documents/write-a-document.md): Create a document in Sleekplan, format it with Markdown and the slash menu, set its type and status, and save it.
- [Link documents to feedback](https://sleekplan.com/help/documents/link-feedback.md): Connect a document to the feedback posts it informs, from the document or from the post, so the reasoning behind a request sits next to the request.
- [Version history and restore](https://sleekplan.com/help/documents/version-history.md): Every save of a Sleekplan document is kept as a version. See exactly what changed in any version, and restore an earlier one without losing anything.
- [Document types](https://sleekplan.com/help/documents/document-types.md): Rename and recolour Sleekplan's built-in document types, add your own, and safely delete a type that documents are still using.
- [The roadmap](https://sleekplan.com/help/roadmap/index.md): The roadmap is a board of your feedback posts grouped into columns. Switch between Status, Quarter, and Month views, and drag posts between status columns to update their progress.
- [Using the ETA based roadmap](https://sleekplan.com/help/roadmap/eta-roadmap.md): Arrange your roadmap by timeline instead of status. The Month and Quarter views group feedback posts by their estimated delivery date, so you can share a time-based plan with your users.
- [The changelog](https://sleekplan.com/help/changelog/index.md): The changelog is where you publish product updates to your users, one change at a time or as batched release notes. Learn how to read the changelog list in the admin and use its status filters, category filter, and search.
- [Create changelog entries](https://sleekplan.com/help/changelog/create-entries.md): Write and publish a changelog entry from the admin: format with Markdown, add inline images and attachments, use the slash and selection toolbars, schedule for later, notify subscribers, target a segment, and credit an author and contributors.
- [Unpublish and duplicate entries](https://sleekplan.com/help/changelog/unpublish-and-duplicate.md): Take a published changelog entry off your portal and widget without deleting it, schedule an automatic takedown with an unpublish date, and duplicate an entry to reuse its content for the next release or the next maintenance notice.
- [In-app announcements](https://sleekplan.com/help/changelog/in-app-announcements.md): In-app announcements surface a newly published changelog entry as a New Updates pop-up inside your widget. Learn how to turn one on for an entry, how segment targeting decides who sees it, and how to hide announcements on specific pages.
- [Surveys](https://sleekplan.com/help/surveys/index.md): Surveys let you ask your users a set of questions and collect their answers, from a one-question NPS check to a multi-step questionnaire. Learn what a survey is in Sleekplan, how the Surveys screen is organized, and where surveys appear to your users.
- [Create a survey](https://sleekplan.com/help/surveys/create-survey.md): Build a survey in the Sleekplan survey editor. Learn how to name a survey, add and edit questions, mark questions as required, reorder them, and save. Editing a survey keeps its past responses intact.
- [Question types](https://sleekplan.com/help/surveys/question-types.md): Sleekplan surveys support seven question types: single choice, multiple choice, scale, NPS, CSAT, free text, and text block. Learn what each one collects, which have fixed formats, and how NPS and CSAT questions feed your analytics dashboards.
- [Conditional display logic](https://sleekplan.com/help/surveys/conditional-logic.md): Display logic shows a survey question only when an earlier answer matches a condition, so respondents see just the questions relevant to them. Learn how to add a rule, the four conditions available, and how the rules behave.
- [Share and target a survey](https://sleekplan.com/help/surveys/share-and-target.md): Show a Sleekplan survey to your users in two ways: share its public link, or attach it to a widget popup with an audience, timing, and page rules. Learn both, and how to reach the right people.
- [Read survey results](https://sleekplan.com/help/surveys/results.md): Read your Sleekplan survey results: the Summary tab breaks down every question, the Responses tab lists individual answers, and the Overview panel shows stats like completion rate. Learn how each is read.
- [Insights dashboards](https://sleekplan.com/help/insights/index.md): Build your own analytics dashboards in Sleekplan. Put the numbers your team checks every week, like new posts, votes, completed requests, page views, NPS, and CSAT, on one page.
- [Add and arrange insights](https://sleekplan.com/help/insights/build-a-dashboard.md): Edit an Insights dashboard: add numbers and charts, choose how each one is shown, drag and resize them on the grid, and filter the whole dashboard.
- [Metrics and charts](https://sleekplan.com/help/insights/metrics.md): What each Insights metric counts, which views, breakdowns, and filters it supports, and how dates, comparisons, and chart types work on an Insights dashboard.
- [Sleek Intelligence](https://sleekplan.com/help/sleek-intelligence/index.md): The AI layer built into Sleekplan that imports, processes, groups and acts on your feedback, plus Sleekmate, your in-app product copilot.
- [Sources](https://sleekplan.com/help/sleek-intelligence/sources.md): Automatically import feedback into Sleekplan from review sites, connected apps, email forwarding and an API endpoint, and control how duplicates are handled.
- [Feedback processing](https://sleekplan.com/help/sleek-intelligence/processing.md): Automatically triage new posts and comments with AI: flag spam, suggest merges, strip confidential data, write follow-ups and label sentiment.
- [Reviewing AI actions](https://sleekplan.com/help/sleek-intelligence/review.md): The Review queue is where AI-proposed changes and user-submitted posts wait for a human to approve, edit or reject before they go live.
- [Topics](https://sleekplan.com/help/sleek-intelligence/topics.md): Topics groups related feedback into AI-clustered themes and sub-topics, so you can see what people are really asking for and how each theme trends.
- [Sleekmate](https://sleekplan.com/help/sleek-intelligence/sleekmate.md): Your in-app product copilot. Ask Sleekmate about your feedback, roadmap and changelog, spot trends, and let it draft entries or take actions for you.
- [Skills](https://sleekplan.com/help/sleek-intelligence/skills.md): Write down how a task should be done once. Sleekmate follows it whenever it applies, and your connected MCP clients can load it too.
- [Schedules](https://sleekplan.com/help/sleek-intelligence/schedules.md): Let Sleekmate run your instructions on a schedule, like every Monday morning, or whenever something happens in your workspace, like a new post.
- [Connectors](https://sleekplan.com/help/sleek-intelligence/connectors.md): Connect Sleekmate to the other tools your team works in, like Linear, Jira or Notion, so it can look things up and take actions there too.
- [Sleek Intelligence credits](https://sleekplan.com/help/sleek-intelligence/credits.md): How AI credits power Sleek Intelligence, how many each action uses, your monthly quota, and how to top up when you run low.
- [Portal & Widget](https://sleekplan.com/help/portal-widget/index.md): Set up and customize your feedback portal and widget.
- [Choose the widget's home screen](https://sleekplan.com/help/portal-widget/widget-home-screen.md): The home screen is the first thing a visitor sees when they open your widget. Pick which section loads first: the feedback board, the changelog, or the roadmap. This guide shows how to set it and what each choice looks like to a visitor.
- [Set up a widget action screen](https://sleekplan.com/help/portal-widget/widget-action-screen.md): The action screen turns your widget's home into a custom launcher of tiles: create a post, open the roadmap, jump to a help page, start a chat, and more. This guide shows how to switch it on and build each action item.
- [The widget notification badge](https://sleekplan.com/help/portal-widget/notification-badge.md): The notification badge is the small red counter on your widget button that tells users something is new. Learn what it counts, which plan it needs, how to put it on your own button, and why it sometimes stays hidden.
- [Popups](https://sleekplan.com/help/portal-widget/popups.md): Popups are in-app messages your widget shows to the right people at the right moment. Learn the five popup types, how in-app announcements and survey popups differ, and how to create, edit, and delete a popup.
- [Submission & voting settings](https://sleekplan.com/help/portal-widget/feedback-submission-voting.md): Control what people can do when they submit and vote on your feedback board: downvotes, priority, comment likes, screen captures, upvoter notifications, and automatic status comments.
- [Public board display settings](https://sleekplan.com/help/portal-widget/feedback-board-display.md): Set what visitors see first on your public feedback board: the default sort, category, and status filter, whether tags and dates show, and how much metadata each post carries.
- [Moderate posts and comments](https://sleekplan.com/help/portal-widget/feedback-moderation.md): Hold new posts and comments for your team to approve before they appear on your public board, and use a word list to moderate only the submissions that need a closer look.
- [Show tags on your public board](https://sleekplan.com/help/portal-widget/public-tags.md): By default, tags are internal. Two settings on the Feedback board page make them public: let users apply tags when they submit a post, and let visitors filter the public board by tag.
- [Show components on your public board](https://sleekplan.com/help/portal-widget/public-components.md): Components are internal by default. Two settings on the Feedback board page make them public: show which part of the product each post is about and let visitors filter by it, and let users pick a component when they submit.
- [Changelog settings](https://sleekplan.com/help/portal-widget/changelog-settings.md): Configure how your public changelog behaves: let visitors subscribe to updates, auto-subscribe new users, publish completed feedback automatically, and collect reactions on each entry.
- [Access the changelog RSS feed](https://sleekplan.com/help/portal-widget/changelog-rss-feed.md): Every public portal publishes its changelog as an RSS 2.0 feed at /changelog/rss.xml, so readers and tools like Slack, Zapier, or an RSS reader can follow your product updates automatically.
- [Show or hide your portal in search engines](https://sleekplan.com/help/portal-widget/search-engine-indexing.md): One switch decides whether Google and other search engines can list your public feedback portal. Turn it on so your roadmap and ideas show up in search results, or off to keep the portal out of search entirely.
- [Add custom code to your portal](https://sleekplan.com/help/portal-widget/custom-code.md): Inject your own HTML, head markup, CSS, and JavaScript into your standalone feedback portal to match your brand, load fonts, add analytics, or restyle the page.
- [How to add analytics tracking to your public board](https://sleekplan.com/help/portal-widget/analytics-tracking.md): Track visitor behavior on your standalone Sleekplan board by adding Google Analytics or any third-party analytics snippet through the Portal custom code settings.
- [Personalize your widget with variables](https://sleekplan.com/help/portal-widget/variables.md): Variables drop a visitor's own name or email into your widget titles, popups, and survey questions, so each person sees a message addressed to them. This guide covers the syntax, the four available variables, and where they work.
- [Control who can access your board](https://sleekplan.com/help/portal-widget/access-privacy.md): The Access & Privacy settings decide two things: who can reach your public portal (open, password, email domains, or single sign-on) and how the people who reach it sign in before they vote, post, or comment. See exactly what each private mode looks like to a visitor.
- [Hide customer identity on your board](https://sleekplan.com/help/portal-widget/customer-identity.md): Stop your public board from revealing who your customers are. Random usernames replace user-chosen handles with neutral ones like yellow_tree, and Hide full names keeps real names and profile pictures visible only to your team.
- [Show your Terms and Privacy Policy](https://sleekplan.com/help/portal-widget/legal.md): Add your Terms and Privacy Policy links to the widget sign-up form, and optionally make users tick an I Agree checkbox before they identify themselves. Point the links at your own legal pages or use Sleekplan's defaults.
- [Web storage and browser cookies](https://sleekplan.com/help/portal-widget/cookies.md): Every cookie and web storage key the Sleekplan portal and widget set, what each one is for, how long it lasts, and suggested language for your own privacy policy. All storage is first-party and used only to run the service.
- [Customize email layouts and content](https://sleekplan.com/help/portal-widget/email-templates.md): Edit the HTML layout and the subject and body of every notification email Sleekplan sends to your users, so they match your wording and branding. Uses editable templates with placeholders you keep in place.
- [Connect a custom domain](https://sleekplan.com/help/portal-widget/custom-domain.md): Host your public feedback portal on your own domain, like feedback.yourcompany.com, instead of the free Sleekplan address. You add one CNAME record and we issue an SSL certificate automatically.
- [Set up a custom email sending domain](https://sleekplan.com/help/portal-widget/custom-email-domain.md): Send Sleekplan notification emails from your own domain, like feedback@yourcompany.com, so replies and updates come from you instead of Sleekplan's default address. You verify the address and add DKIM records.
- [Add custom Content Security Policy (CSP) rules](https://sleekplan.com/help/portal-widget/custom-csp-rules.md): Extend the Content Security Policy that Sleekplan serves for your hosted feedback portal so third-party scripts, styles, frames, and fonts you add through custom code are not blocked.
- [Integrations](https://sleekplan.com/help/integrations/index.md): Connect Sleekplan with the tools your team already uses.
- [Jira Cloud integration](https://sleekplan.com/help/integrations/jira-cloud.md): Connect Sleekplan to Jira Cloud to link feedback posts with Jira issues and keep their statuses in sync both ways.
- [Jira integration (Data Center)](https://sleekplan.com/help/integrations/jira-data-center.md): Connect Sleekplan to your self-hosted Jira Data Center or Server instance to create, link, and status-sync feedback posts with Jira issues.
- [Azure DevOps integration](https://sleekplan.com/help/integrations/azure-devops.md): Connect an Azure DevOps organization to Sleekplan to link feedback posts with work items, create work items from posts, and keep statuses in sync in both directions.
- [GitHub integration](https://sleekplan.com/help/integrations/github.md): Connect GitHub to link Sleekplan feedback posts to issues, sync statuses in both directions, and auto-create posts from new GitHub issues.
- [Linear integration](https://sleekplan.com/help/integrations/linear.md): Connect Linear to Sleekplan so you can link feedback posts to Linear issues, create issues from a post, and keep statuses in sync both ways.
- [ClickUp integration](https://sleekplan.com/help/integrations/clickup.md): Connect ClickUp to Sleekplan so you can link feedback posts to ClickUp tasks, create tasks from a post, and keep statuses in sync both ways.
- [Slack integration](https://sleekplan.com/help/integrations/slack.md): Connect Sleekplan to Slack to get feedback, comment, survey, and changelog-subscriber notifications in a channel, and to create posts and changelog updates with slash commands.
- [Intercom integration](https://sleekplan.com/help/integrations/intercom.md): Connect Sleekplan to Intercom to embed your feedback board, roadmap, and changelog in the Messenger, and to search, create, and vote on posts straight from a conversation.
- [Zapier integration](https://sleekplan.com/help/integrations/zapier.md): Connect Sleekplan to Zapier to automate feedback, changelog, and user workflows across thousands of other apps, using triggers and actions with no code.
- [Import data into your workspace](https://sleekplan.com/help/integrations/import/index.md): Bring feedback posts, changelog updates, and user accounts into Sleekplan from a CSV file or from another tool like Canny, Upvoty, or UserVoice.
- [Import from a CSV file](https://sleekplan.com/help/integrations/import/csv.md): Prepare a CSV, map its columns, and import feedback posts, changelog updates, or user accounts into your Sleekplan workspace.
- [Import from Canny, Upvoty, or UserVoice](https://sleekplan.com/help/integrations/import/from-other-tools.md): Move your feedback board over from Canny, Upvoty, or UserVoice using an API key. Sleekplan pulls in your posts, comments, votes, and users automatically.
- [Export your workspace data](https://sleekplan.com/help/integrations/export.md): Download a full CSV snapshot of your workspace's feedback, comments, votes, changelog, user accounts, and survey responses from Settings → Export.
- [Custom integrations](https://sleekplan.com/help/integrations/custom-integrations.md): Connect Sleekplan to your own systems with webhooks, an admin Canvas panel, and API access when no built-in integration fits.
- [Account & security](https://sleekplan.com/help/account-security/index.md): Manage your account settings, billing, and workspace security.
- [Billing, plans, and your subscription](https://sleekplan.com/help/account-security/billing.md): Understand how your free trial works, then upgrade, downgrade, or cancel your Sleekplan plan and manage payment details from one screen.
- [Add-ons](https://sleekplan.com/help/account-security/add-ons.md): Extend your plan with extra team seats, emails, popups, announcements, SAML SSO, and Sleek Intelligence credits, without moving to a bigger plan.
- [Invite teammates](https://sleekplan.com/help/account-security/invite-team.md): Add colleagues to your Sleekplan workspace so they can triage feedback, publish changelog updates, and manage your board together.
- [Team roles and permissions](https://sleekplan.com/help/account-security/roles-permissions.md): Invite people to your workspace and control what they can do with the Owner, Admin, and Member roles.
- [How Sleekplan handles end-user accounts](https://sleekplan.com/help/account-security/end-user-accounts.md): Understand the difference between admin accounts and end-user accounts: your customers never sign up at Sleekplan, they belong only to your workspace.
- [Set up user segments](https://sleekplan.com/help/account-security/segments.md): Group your customers into saved audiences built from their profile and activity, then use those segments to filter feedback, target popups, gate categories, and personalize action items.
- [Companies and teams](https://sleekplan.com/help/account-security/groups.md): See your feedback rolled up by account: what a group is, how to read the list, and how to manage members.
- [Emails Sleekplan sends to your users](https://sleekplan.com/help/account-security/emails.md): Every email your end users can receive, who gets each one, how Sleekplan delivers them reliably (SPF, DKIM, DMARC via Amazon SES), and how to send from your own domain.
- [Find customers who aren't receiving your emails](https://sleekplan.com/help/account-security/sending-health.md): Check any customer's sending health to see whether your notification emails are actually reaching them, why a stopped address was stopped, and how to start sending again.
- [Check what happened to a customer's emails](https://sleekplan.com/help/account-security/email-delivery-status.md): Open a customer's Emails tab to see every notification Sleekplan sent them and what happened to each one: sent, still queued, bounced, or never sent at all.
- [Enable two-factor authentication](https://sleekplan.com/help/account-security/two-factor-authentication.md): Add a second layer of security to your Sleekplan account with an authenticator app and a recovery key.
- [Set up Directory Sync (SCIM)](https://sleekplan.com/help/account-security/directory-sync.md): Connect Okta, Microsoft Entra ID, or another SCIM directory so team seats and portal users are created, updated, and removed automatically when people join or leave.
- [How Sleekplan complies with GDPR](https://sleekplan.com/help/account-security/gdpr-compliance.md): Sleekplan is a Munich-based company that operates under European data protection law. Learn what data we process, where it is stored, who our sub-processors are, and how we help you meet your own GDPR obligations.

## OpenAPI Specs

- [openapi-v2](/docs/api/openapi-v2.yaml)
- [openapi](/docs/api/openapi.yaml)


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