# Sleekplan

## Docs

- [Create a comment](https://sleekplan.com/docs/api-reference/comment/create-a-comment.md)
- [Delete a comment](https://sleekplan.com/docs/api-reference/comment/delete-a-comment.md)
- [Like a comment](https://sleekplan.com/docs/api-reference/comment/like-a-comment.md)
- [List comments on a post](https://sleekplan.com/docs/api-reference/comment/list-comments-on-a-post.md)
- [Retrieve a comment](https://sleekplan.com/docs/api-reference/comment/retrieve-a-comment.md)
- [Update a comment](https://sleekplan.com/docs/api-reference/comment/update-a-comment.md)
- [Send content to the intelligence queue](https://sleekplan.com/docs/api-reference/intelligence/send-content-to-the-intelligence-queue.md)
- [Add or update post metadata](https://sleekplan.com/docs/api-reference/meta/add-or-update-post-metadata.md)
- [Get post metadata](https://sleekplan.com/docs/api-reference/meta/get-post-metadata.md)
- [Remove post metadata key](https://sleekplan.com/docs/api-reference/meta/remove-post-metadata-key.md)
- [Create a post](https://sleekplan.com/docs/api-reference/post/create-a-post.md)
- [Delete a post](https://sleekplan.com/docs/api-reference/post/delete-a-post.md): Permanently deletes a post. Cannot be undone.
- [List posts](https://sleekplan.com/docs/api-reference/post/list-posts.md): Returns a list of feedback posts. Sorted by trend by default.
- [Retrieve a post](https://sleekplan.com/docs/api-reference/post/retrieve-a-post.md)
- [Update a post](https://sleekplan.com/docs/api-reference/post/update-a-post.md)
- [Create an NPS response](https://sleekplan.com/docs/api-reference/promoter/create-an-nps-response.md)
- [List NPS responses](https://sleekplan.com/docs/api-reference/promoter/list-nps-responses.md)
- [Create a satisfaction response](https://sleekplan.com/docs/api-reference/satisfaction/create-a-satisfaction-response.md)
- [List satisfaction responses](https://sleekplan.com/docs/api-reference/satisfaction/list-satisfaction-responses.md)
- [Create a changelog update](https://sleekplan.com/docs/api-reference/update/create-a-changelog-update.md)
- [Create a satisfaction response for an update](https://sleekplan.com/docs/api-reference/update/create-a-satisfaction-response-for-an-update.md)
- [Delete a changelog update](https://sleekplan.com/docs/api-reference/update/delete-a-changelog-update.md)
- [List changelog updates](https://sleekplan.com/docs/api-reference/update/list-changelog-updates.md): Returns changelog updates sorted by date, most recent first.
- [List satisfaction responses for an update](https://sleekplan.com/docs/api-reference/update/list-satisfaction-responses-for-an-update.md)
- [Retrieve a changelog update](https://sleekplan.com/docs/api-reference/update/retrieve-a-changelog-update.md)
- [Update a changelog update](https://sleekplan.com/docs/api-reference/update/update-a-changelog-update.md)
- [Create an end-user](https://sleekplan.com/docs/api-reference/user/create-an-end-user.md)
- [Delete an end-user](https://sleekplan.com/docs/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/docs/api-reference/user/get-unread-notification-count.md)
- [List end-users](https://sleekplan.com/docs/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.
- [Retrieve an end-user](https://sleekplan.com/docs/api-reference/user/retrieve-an-end-user.md)
- [Update an end-user](https://sleekplan.com/docs/api-reference/user/update-an-end-user.md): Updates an end-user. Any parameter not provided is left unchanged.
- [Create or update a vote](https://sleekplan.com/docs/api-reference/vote/create-or-update-a-vote.md)
- [List votes on a post](https://sleekplan.com/docs/api-reference/vote/list-votes-on-a-post.md)
- [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
- [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
- [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
- [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
- [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 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
- [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
- [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
- [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
- [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
- [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
- [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
- [Listen to SDK events](https://sleekplan.com/docs/sdk/events.md): Use $sleek.on() to react to widget lifecycle and authentication events, plus a full reference for every event the SDK emits
- [JavaScript SDK overview](https://sleekplan.com/docs/sdk/overview.md): Control the Sleekplan widget from your own code: open or close views, toggle the launcher button, add HTML triggers, and configure session behavior
- [Show CSAT, feedback, and changelog popups](https://sleekplan.com/docs/sdk/popups.md): Trigger satisfaction surveys, feedback prompts, and changelog announcement popups programmatically with $sleek.showPopup()
- [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
- [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
- [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

## OpenAPI Specs

- [openapi](https://sleekplan.com/docs/api/openapi.yaml)