# Introduction
Source: https://help.suggix.com/api-reference/introduction

Suggix API overview

<Note>
  **Suggix API is currently under development**

  The public API for Suggix has not been released yet.\
  This section will be updated with authentication, endpoint, webhook, and rate limit documentation when the API becomes available.
</Note>

For integration options that are currently available, see:

<CardGroup>
  <Card title="SSO Integration" icon="key" href="/development/sso">
    Authenticate users with JWT-based Single Sign-On.
  </Card>

  <Card title="Custom Domains" icon="globe" href="/development/custom-domains">
    Serve your feedback portal from your own domain.
  </Card>
</CardGroup>


# Development
Source: https://help.suggix.com/development

Integrate Suggix with your product, authentication flow, and custom domain.

This document explains how to integrate **Suggix** into your product, including:

* Embedding the feedback portal
* Setting up a custom domain
* Enabling SSO login

***

## Integrate the feedback portal

Suggix provides a hosted feedback portal that you can embed or link to from your product.

### Direct link

The simplest way is to link users directly to your Suggix portal:

```text theme={null}
https://{workspace}.suggix.com
```

You can place this link in:

* Navigation menus
* Help / Feedback buttons
* User dashboards
* Product update emails
* Support center articles

### Custom domain

If you want the portal to live under your own domain, configure a custom domain such as:

```text theme={null}
https://feedback.example.com
```

See the [Custom Domains guide](/development/custom-domains) for DNS and SSL setup.

## Authenticate users with SSO

Suggix supports JWT-based Single Sign-On (SSO) so users can access your feedback portal from your existing authentication flow.

Use SSO when you want to:

* Avoid asking users to create a separate Suggix account
* Identify feedback by your application's user IDs
* Keep voting and commenting tied to authenticated users
* Redirect unauthenticated users back to your own login page

See the [SSO Integration guide](/development/sso) and [Generate SSO Token guide](/development/jwt) for implementation details.

## Recommended integration flow

<Steps>
  <Step title="Create and configure your workspace">
    Set your workspace name, logo, brand color, and public subdomain in [Workspace General Settings](/settings/general).
  </Step>

  <Step title="Create feedback boards">
    Add boards for the types of feedback you want to collect. See [Feedback Boards](/guides/boards).
  </Step>

  <Step title="Add product entry points">
    Link to your portal from your app navigation, user menu, help menu, or feedback button.
  </Step>

  <Step title="Enable SSO if needed">
    Generate JWT tokens server-side and redirect users to the portal with the `ssoToken` query parameter.
  </Step>

  <Step title="Configure a custom domain">
    Add DNS records after your portal workflow is ready for users.
  </Step>
</Steps>

<Warning>
  Never generate SSO tokens in browser-side code. The SSO private key must stay on your server.
</Warning>


# Custom Domains
Source: https://help.suggix.com/development/custom-domains

Use a custom domain for your Suggix feedback portal.

Suggix supports custom domains, allowing you to serve your public feedback portal under your own brand domain, such as `feedback.example.com` or `ideas.example.com`.

To use a custom domain with Suggix:

1. Add your domain in the Suggix dashboard.
2. Configure DNS records with your domain provider.
3. Wait for DNS propagation and automatic SSL certificate provisioning.

## Add your custom domain

1. Navigate to the [Custom domain setup](https://www.suggix.com/_/settings/developer) page in your dashboard.
2. Enter your domain name. For example, `feedback.example.com` or `www.example.com`.
3. Click **Save**.

<img alt="Custom Domain" />

## Configure your DNS

1. On your domain provider's website, navigate to your domain's DNS settings.
2. Create a new DNS record with the following values:

```text theme={null} theme={null}
CNAME | your-subdomain | your-subdomain.suggix.com.
```

For `feedback.example.com`, the DNS record usually looks like this:

```text theme={null}
Type: CNAME
Name: feedback
Value: your-subdomain.suggix.com
```

<Tip>
  Each domain provider has different ways to add DNS records. Refer to your domain provider's documentation for specific instructions.
</Tip>

### DNS propagation

DNS changes typically take 1-24 hours to propagate globally, though it can take up to 48 hours in some cases. You can verify your DNS is configured correctly using [DNSChecker](https://dnschecker.org).

Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after Vercel provisions your TLS certificate.

### Automatic TLS provisioning

Once your DNS records propagate and resolve correctly, Vercel automatically provisions a free SSL/TLS certificate for your domain using Let's Encrypt.

This typically completes within a few hours of DNS propagation, though it can take up to 24 hours in rare cases. Certificates are automatically renewed before expiration.

### CAA records

If your domain uses CAA (Certification Authority Authorization) records, you must authorize Let's Encrypt to issue certificates for your domain. Add the following CAA record to your DNS settings:

```text theme={null} theme={null}
0 issue "letsencrypt.org"
```

## Troubleshooting

If the custom domain does not work after DNS propagation:

* Confirm the CNAME value points to your Suggix subdomain.
* Confirm there are no conflicting A, AAAA, or CNAME records for the same hostname.
* Check whether your DNS provider automatically appends the root domain to record values.
* Wait for SSL provisioning to complete after DNS starts resolving correctly.


# Generate SSO Token
Source: https://help.suggix.com/development/jwt

Generate JWT-based SSO tokens on your server for Suggix authentication.

### Install a JWT library

We use JSON Web Tokens to securely authenticate your users. First, install the appropriate JWT library for your server.

<Steps>
  <Step title="Get SSO Private Key">
    Go to your Suggix [**Dashboard → Settings → Developer**](https://www.suggix.com/_/settings/developer) to find your SSO private key.

    <img alt="&#x22;private_key&#x22;" />

    <Warning>
      Store this key securely on your server and never share it publicly.
    </Warning>
  </Step>

  <Step title="Install a JWT library">
    <Tabs>
      <Tab title="Node.js">
        ```bash theme={null}
        npm install --save jsonwebtoken
        ```
      </Tab>

      <Tab title="C#">
        ```bash theme={null}
        dotnet add package System.IdentityModel.Tokens.Jwt
        ```
      </Tab>

      <Tab title="Go">
        ```bash theme={null}
        go get github.com/golang-jwt/jwt
        ```
      </Tab>

      <Tab title="Java">
        ```bash theme={null}
        # See instructions here:
        https://mvnrepository.com/artifact/io.jsonwebtoken/jjwt
        ```
      </Tab>

      <Tab title="PHP">
        ```bash theme={null}
        composer require firebase/php-jwt
        ```
      </Tab>

      <Tab title="Python">
        ```bash theme={null}
        pip install PyJWT
        ```
      </Tab>

      <Tab title="Ruby">
        ```bash theme={null}
        sudo gem install jwt
        ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="Generate the JWT Token">
    <Tabs>
      <Tab title="Node.js">
        ```js theme={null}
          var jwt = require('jsonwebtoken');

          var PrivateKey = 'Your SSO Private Key';

          function createSSOToken(user) {
            var userData = {
              email: user.email,
              name: user.name,
              id: user.id, // optional
              photo_url: user.photo_url, // optional
            };
            return jwt.sign(userData, PrivateKey, {algorithm: 'HS256'});
          }
        ```
      </Tab>

      <Tab title="C#">
        ```c# theme={null}
        using System;
        using System.IdentityModel.Tokens.Jwt;
        using System.Security.Claims;
        using System.Text;
        using Microsoft.IdentityModel.Tokens;

        public class JwtHelper
        {
            private static string PrivateKey = "Your SSO Private Key";

            public static string CreateToken(User user)
            {
              byte[] keyBytes = Encoding.UTF8.GetBytes(PrivateKey);
              var securityKey = new SymmetricSecurityKey(keyBytes);

              var credentials = new SigningCredentials(securityKey, "HS256");
              var header = new JwtHeader(credentials);
              var payload = new JwtPayload
              {
                { "email": user.email },
                { "name": user.name },
                { "id": user.id }, // optional
                { "photo_url": user.photoURL }, // optional, but preferred
              };

              var securityToken = new JwtSecurityToken(header, payload);
              var handler = new JwtSecurityTokenHandler();

              return handler.WriteToken(securityToken);
            }
        }
        ```
      </Tab>

      <Tab title="Go">
        ```go theme={null}
        import (
          "github.com/golang-jwt/jwt"
        )

        const PrivateKey = "Your SSO Private Key"

        func createSSOToken(user map[string]interface{}) (string, error) {
          token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
            "email": user["email"],
            "name": user["name"],
            "id": user["id"], // optional
            "photo_url": user["photo_url"], // optional
          })
          return token.SignedString([]byte(PrivateKey));
        }
        ```
      </Tab>

      <Tab title="Java">
        ```java theme={null}
        import java.util.HashMap;

        import io.jsonwebtoken.Jwts;
        import io.jsonwebtoken.SignatureAlgorithm;

        public class SSOTokenCreator {
          private static final String PrivateKey = "Your SSO Private Key";

          public static String createToken(User user) throws Exception {
            HashMap<String, Object> userData = new HashMap<String, Object>();
            userData.put("email", user.email);
            userData.put("name", user.name);
            userData.put("id", user.id); // optional
            userData.put("photo_url", user.photoURL); // optional

            return Jwts.builder()
              .setClaims(userData)
              .signWith(SignatureAlgorithm.HS256, PrivateKey.getBytes("UTF-8"))
              .compact();
          }
        }
        ```
      </Tab>

      <Tab title="PHP">
        ```php theme={null}
        use \Firebase\JWT\JWT;

        const PrivateKey = 'Your SSO Private Key';

        function createSSOToken($user) {
          $userData = [
            'email' => $user['email'],
            'name' => $user['name'],
            'id' => $user['id'],
            'photo_url' => $user['photo_url'], // optional
          ];
          return JWT::encode($userData, PrivateKey, 'HS256');
        }
        ```
      </Tab>

      <Tab title="Python">
        ```python theme={null}
        import jwt

        private_key = 'Your SSO Private Key'

        def create_sso_token(user):
          user_data = {
            'email': user.email,
            'name': user.name,
            'id': user.id, # optional
            'photo_url': user.photo_url, # optional
          }
          return jwt.encode(user_data, private_key, algorithm='HS256')
        ```
      </Tab>

      <Tab title="Ruby">
        ```ruby theme={null}
        require 'jwt'

        PrivateKey = 'Your SSO Private Key'

        def createSSOToken(user)
          userData = {
            email: user.email,
            name: user.name,
            id: user.id, #optional
            photo_url: user.photo_url, # optional
          }

          JWT.encode(userData, PrivateKey, 'HS256')
        end

        ```
      </Tab>
    </Tabs>
  </Step>
</Steps>


# SSO Settings
Source: https://help.suggix.com/development/sso

Configure Single Sign-On so users can access your Suggix portal through your existing authentication system.

By default, Suggix uses its own independent user authentication system. You can enable Single Sign-On (SSO) to provide a more seamless experience for users when submitting and managing feedback in Suggix.

<Steps>
  <Step title="Get SSO Private Key">
    Go to your Suggix [**Dashboard → Settings → Developer**](https://www.suggix.com/_/settings/developer) to locate your SSO private key.

    <img alt="&#x22;private_key&#x22;" />

    <Warning>
      Store this key securely on your server. Never expose it in client-side code or share it publicly.
    </Warning>
  </Step>

  <Step title="Generate the SSO token on your server">
    Generate a JWT on your server using your user data, following the example below.
    [Generate the token on your server](/development/jwt)
  </Step>

  <Step title="Redirect to the Suggix portal with the SSO token">
    Redirect the user to the Suggix portal and include the <code>ssoToken</code> as a query parameter.
    Suggix will automatically verify the token and sign the user in.

    Example:\
    <code>[https://feedback.yourwebsite.com/?ssoToken=eyJhbGciOiJIUzI1NiJ9](https://feedback.yourwebsite.com/?ssoToken=eyJhbGciOiJIUzI1NiJ9)...</code>
  </Step>

  <Step title="Configure Login Redirect URL and Home Redirect URL">
    Configure the <strong>Login Redirect URL</strong> in the SSO Settings page to redirect users to your website for authentication when they are not logged in.

    <Note>
      After configuring the Login Redirect URL, the login button in the Suggix portal will redirect users to the specified Login Redirect URL and include a return URL parameter.
      Once the user has successfully signed in on your website, redirect them back to the Suggix feedback portal with the generated ssoToken.

      Example:<code>[https://yourwebsite.com/login?redirect=https://feedback.yourwebsite.com](https://yourwebsite.com/login?redirect=https://feedback.yourwebsite.com)</code>
    </Note>

    Configure the <strong>Home Redirect URL</strong> to allow users to quickly return to your website from the Suggix feedback portal.
  </Step>
</Steps>

## Required token fields

Your JWT payload must include:

| Field   | Type   | Description        |
| ------- | ------ | ------------------ |
| `email` | string | User email address |
| `name`  | string | User display name  |

Optional fields:

| Field       | Type   | Description                          |
| ----------- | ------ | ------------------------------------ |
| `id`        | string | Stable user ID from your application |
| `photo_url` | string | Public avatar URL                    |

<Tip>
  Include a stable `id` when possible. It helps Suggix keep the same user identity even if a user's email address changes later.
</Tip>

## Redirect flow

1. A user clicks a feedback link in your product.
2. Your server verifies the user is signed in.
3. Your server generates an SSO token with the Suggix private key.
4. Your app redirects the user to the Suggix portal with `ssoToken`.
5. Suggix verifies the token and signs the user in.


# Feedback Boards
Source: https://help.suggix.com/guides/boards

Create and organize boards for feature requests, bug reports, ideas, and roadmap feedback.

Boards are the main place where users submit feedback in Suggix. Each board has its own public URL, submission form, display settings, and collection of posts.

Use separate boards when different types of feedback need different instructions, review flows, or public visibility. Common examples include:

* Feature Requests
* Bug Reports
* Product Ideas
* Integrations
* Roadmap

## Create a board

<Steps>
  <Step title="Open board settings">
    Go to **Settings → Boards** in your Suggix dashboard.
  </Step>

  <Step title="Create a new board">
    Add a board name, URL slug, and description. The name and description should help users understand what kind of feedback belongs on the board.
  </Step>

  <Step title="Configure public behavior">
    Decide whether users can create posts, whether anonymous posting is allowed, and whether vote counts and voters are visible.
  </Step>

  <Step title="Save and share">
    After saving, open the public board URL and share it with users from your website, app, help center, or product emails.
  </Step>
</Steps>

<img alt="Create a new board in Suggix" />

## Choose a board structure

Start with a small number of boards. Too many boards make it harder for users to decide where to post and harder for your team to triage feedback.

| Structure                      | Best for                                            |
| ------------------------------ | --------------------------------------------------- |
| One board for all feedback     | Early products, small teams, low feedback volume    |
| Feature requests + bug reports | Teams that need to separate ideas from defects      |
| Boards by product area         | Larger products with clear modules or product lines |
| Read-only roadmap board        | Public status tracking without new submissions      |

<Tip>
  If users often submit the same type of request in the wrong place, rename the board or update its description before creating more boards.
</Tip>

## Configure submission copy

Each board can customize the form text users see when they create a post.

* **Title placeholder**: Ask for a concise summary.
* **Details placeholder**: Ask for context, use cases, screenshots, or expected behavior.
* **Button text**: Match the board purpose, such as `Submit idea` or `Report bug`.

Clear prompts improve the quality of feedback and reduce follow-up work for your team.

## Manage posts

After users submit feedback, review posts regularly and keep the public status current.

* Merge or close duplicate posts when needed.
* Apply tags to group related feedback.
* Update status when work moves from review to planned, in progress, or completed.
* Add comments when you need more context or want to explain a decision.

For the full dashboard workflow, see [Post Management](/guides/post-management).

## Related settings

<CardGroup>
  <Card title="Board configuration" icon="columns" href="/settings/board">
    Configure board names, URLs, public behavior, form copy, tags, and deletion.
  </Card>

  <Card title="Feedback Portal" icon="messages-square" href="/guides/feedback-portal">
    Learn how users browse, submit, vote on, and discuss feedback.
  </Card>
</CardGroup>


# Changelog
Source: https://help.suggix.com/guides/changelog

Create, schedule, edit, publish, and manage product updates in Suggix.

The Changelog module helps you publish product updates and keep users informed about what has changed. Use it for release notes, feature announcements, important improvements, bug fixes, and other updates that users should know about.

Published changelog entries appear on your public feedback portal. Users can search updates, read details, and like entries that are useful to them.

<img alt="Public changelog display in Suggix" />

## Changelog list

Open **Changelog** from the Suggix dashboard sidebar to view and manage all changelog entries.

<img alt="Changelog list in the Suggix dashboard" />

The list includes:

* **Status filters**: View `All`, `Draft`, `Scheduled`, or `Published` entries.
* **Search**: Find entries by title or content.
* **Sorting**: Sort by publish time, likes, or views.
* **Grouped sections**: Entries are grouped by status so drafts, scheduled releases, and published updates are easy to scan.
* **Entry dates**: Published and scheduled entries show their relevant release date.

Use the list to review upcoming releases, find older updates, and check which announcements are already public.

## Create a changelog

Click the create button in the top-right corner of the Changelog page to add a new entry.

<img alt="Create a new changelog entry" />

When creating an entry, include:

* **Title**: A clear release title, such as `Version 3.4.0` or `Faster loading`.
* **Summary**: A short opening paragraph that explains the value of the update.
* **Sections**: Group related changes under headings such as `New Features`, `Improvements`, or `Bug Fixes`.
* **Details**: Explain what changed, who benefits, and whether users need to take action.
* **Images**: Add screenshots when the update changes a visible workflow or interface.

<Tip>
  Write changelog entries for users, not only for your internal team. Lead with the user-visible benefit before adding implementation details.
</Tip>

## Publish now or schedule release

You can publish a changelog immediately or schedule it for a future date and time.

<img alt="Scheduled changelog release date and time picker" />

Use **Publish Now** when the update is already live. Use a scheduled release when you want the changelog to go public at the same time as a product launch, maintenance window, or marketing announcement.

Scheduled changelog entries remain hidden from the public portal until the selected publish time.

## Edit a changelog

Open an entry from the Changelog list to edit it.

You can update:

* Title and body content
* Release details and formatting
* Embedded images
* Publish time
* Draft, scheduled, or published state

The editor also shows entry properties, including creation time, update time, publish time, views, and likes.

<Note>
  For published entries, save changes carefully because updates affect what users see on the public portal.
</Note>

## More actions

Use the more actions menu in the entry editor for destructive or state-changing operations.

<img alt="Changelog more actions menu" />

Available actions depend on the entry state:

* **Delete**: Permanently remove the changelog entry.
* **Unpublish**: Remove a published entry from the public portal and return it to a non-public state.

## Delete a changelog

To delete an entry:

<Steps>
  <Step title="Open the changelog entry">
    Select the entry from the Changelog list.
  </Step>

  <Step title="Open more actions">
    Click the more actions menu in the top-right corner.
  </Step>

  <Step title="Choose Delete">
    Confirm the deletion only after verifying the entry is no longer needed.
  </Step>
</Steps>

<Warning>
  Deleting a changelog entry is permanent. If you only need to hide a published entry, use **Unpublish** instead.
</Warning>

## Public changelog experience

Published entries appear in the public portal under the Changelog tab.

Users can:

* Search changelog entries.
* Read the full update by selecting **Read more**.
* Like entries to show interest.
* Browse updates by release date.

Use concise titles and clear summaries so users can quickly understand what changed from the list view.

## What to publish

Publish updates when users need to know about a meaningful change.

Good changelog entries include:

* New features
* Important improvements
* Bug fixes that affected many users
* Workflow or UI changes
* Integrations and API changes
* Deprecations or breaking changes

Avoid publishing very small internal changes unless they affect the user experience.

## Best practices

* Use clear titles instead of vague release names.
* Keep entries concise and user-focused.
* Mention breaking changes near the top.
* Add screenshots for visible product changes.
* Schedule entries when the release should go public at a specific time.
* Unpublish instead of deleting when you may need the entry again later.
* Publish consistently so users know the portal is active.

## Related guides

<CardGroup>
  <Card title="Voting and prioritization" icon="arrow-up" href="/guides/voting">
    Decide which feedback should move into the roadmap.
  </Card>

  <Card title="Roadmap and status" icon="map" href="/guides/roadmap">
    Keep public statuses aligned with product progress.
  </Card>
</CardGroup>


# Feedback Portal
Source: https://help.suggix.com/guides/feedback-portal

Learn how users browse, create, vote on, and discuss feedback in the public portal.

The feedback portal is the public-facing place where users submit feedback, vote on requests, follow status updates, and discuss ideas with your team.

Users can access the portal from your Suggix subdomain or custom domain. The portal includes Posts, Roadmap, and Changelog navigation when those modules are enabled.

## Browse feedback

The Posts page shows all public feedback and board-specific feedback in one place.

<img alt="Public feedback portal list page" />

Users can:

* Switch between boards from the left sidebar.
* View all posts or posts from a specific board.
* Submit feedback with the primary action button.
* Filter the visible list.
* Sort posts by `Trending`, `Top`, or `New`.
* See vote counts, board names, statuses, priorities, due dates, tags, comment counts, and post dates.

<Tip>
  Encourage users to search and review existing posts before creating a new one. This reduces duplicates and makes voting more useful.
</Tip>

## Create feedback

Users create feedback from the portal by selecting a board and opening the new post dialog.

<img alt="Create new feedback in the public portal" />

The creation dialog includes:

* **Board selector**: Choose where the feedback should be submitted.
* **Title**: Summarize the request or issue.
* **Description editor**: Add details using rich content blocks.
* **Tags**: Add available tags when they are configured for the board.
* **Submit button**: The button text can match the board purpose, such as `Request a Feature`.

The editor supports content blocks such as:

* Text
* Heading 1, Heading 2, and Heading 3
* List
* Checklist
* Image

Good feedback usually includes the problem, expected outcome, current workaround, and any screenshots or examples that help your team understand the request.

## View post details

Selecting a post opens its detail page.

<img alt="Public feedback post detail page" />

The detail page shows:

* Post title and description
* Author and created date
* Board
* Status
* Priority
* Due date
* Tags
* Vote count
* Voter list, when enabled
* Comment thread

Users can vote on a post, leave comments, like comments, and reply to existing comments. Comments help your team gather context without creating duplicate feedback.

## Public interaction settings

Board settings control what users can do on the portal.

* **Read-only** boards let users view posts without creating new ones.
* **Anonymous posting** allows users to submit feedback without signing in.
* **Show voters and comment likers** controls whether public identities appear.
* **Show vote counts** controls whether users can see demand for each post.

For setup details, see [Board Configuration](/settings/board).

## Recommended workflow

<Steps>
  <Step title="Create focused boards">
    Use clear board names such as `Feature Requests`, `Bug Reports`, or `Ideas`.
  </Step>

  <Step title="Share the portal">
    Link users to the portal from your app, website, help center, or onboarding emails.
  </Step>

  <Step title="Encourage voting">
    Ask users to vote on existing posts instead of creating duplicates.
  </Step>

  <Step title="Respond with status updates">
    Keep users informed by updating statuses and adding comments when work moves forward.
  </Step>
</Steps>

## Related guides

<CardGroup>
  <Card title="Post Management" icon="inbox" href="/guides/post-management">
    Review, filter, assign, tag, and update feedback from the dashboard.
  </Card>

  <Card title="Voting and Prioritization" icon="arrow-up" href="/guides/voting">
    Use votes and context to decide what to build next.
  </Card>
</CardGroup>


# Post Management
Source: https://help.suggix.com/guides/post-management

Review, filter, edit, assign, tag, and manage feedback posts in the Suggix dashboard.

The Posts module in the Suggix dashboard is where your team reviews incoming feedback and turns it into organized product work.

Use it to triage posts, update status and priority, assign owners, apply tags, respond to users, and keep feedback aligned with your roadmap.

## Posts list

Open **Posts** from the dashboard sidebar to view all feedback across boards.

<img alt="Suggix dashboard posts list" />

The list shows:

* Vote count
* Status
* Priority
* Post title
* Board name
* Tags
* Created date
* Owner or author avatar

You can sort the list by created date and change sort direction from the top-right controls.

## Filter posts

Use filters to focus the list on the feedback your team needs to review.

<img alt="Filter posts in the dashboard" />

Available filters include:

* Keywords
* Status
* Board
* Tag
* Priority
* Author
* Assignee
* Created Date
* Updated Date
* Due Date
* Votes
* Comments
* Views
* Pinned
* Spam

Filters are useful for triage workflows such as finding unassigned posts, reviewing urgent bugs, checking high-vote requests, or auditing stale planned work.

## Update status

Use status to communicate progress internally and publicly.

<img alt="Update post status from the posts list" />

Available status values include:

* No status
* Backlog
* Planned
* In Progress
* Completed
* Closed

Status changes help users understand whether feedback has been reviewed, accepted, started, completed, or closed.

## Set priority

Use priority to mark urgency and internal importance.

<img alt="Update post priority from the posts list" />

Available priority values include:

* No priority
* Urgent
* High
* Medium
* Low

Priority is an internal planning signal. Combine it with votes, customer impact, effort, and strategy before deciding what to build.

## Assign an owner

Assign an owner when a team member is responsible for reviewing or driving a post.

<img alt="Assign post owner from the posts list" />

Available owner options include workspace members and `No owner`.

<Note>
  Owner information is intended for your team. It helps clarify responsibility without requiring public users to understand your internal workflow.
</Note>

## Apply tags

Tags help group related feedback across boards and workflows.

<img alt="Apply tags from the posts list" />

Use tags for:

* Product areas
* Integrations
* Customer segments
* Themes
* Release groups

Posts can have multiple tags, making it easier to filter and report on related feedback.

## Review post details

Open a post to view full details, comments, voters, and actions.

<img alt="Post detail page in the Suggix dashboard" />

The detail page includes:

* Title and full description
* Vote count and voters
* Board
* Status
* Priority
* Owner
* Tags
* Due date
* Comment thread
* Comment sorting by time or likes

Use the more actions menu to:

* Edit the post
* Pin the post
* Mark the post as spam
* Delete the post

<Warning>
  Delete posts only when they should be permanently removed. For unwanted submissions, marking spam may be a better first step.
</Warning>

## Related guides

<CardGroup>
  <Card title="Feedback Portal" icon="messages-square" href="/guides/feedback-portal">
    Learn how users submit, vote on, and discuss feedback publicly.
  </Card>

  <Card title="Roadmap and Status" icon="map" href="/guides/roadmap">
    Turn managed feedback into roadmap progress.
  </Card>
</CardGroup>


# Roadmap and Status
Source: https://help.suggix.com/guides/roadmap

Use post statuses and due dates to turn feedback into a clear product roadmap.

Suggix helps you turn feedback into a roadmap by keeping each post tied to a status, priority, owner, tags, and optional due date.

The goal is to give users enough visibility to trust the process while keeping internal planning flexible.

## Recommended status flow

Use a simple status model that your team can maintain consistently.

| Status       | Meaning                                                |
| ------------ | ------------------------------------------------------ |
| Open         | Feedback has been received but not reviewed yet        |
| Under Review | Your team is evaluating demand, scope, and fit         |
| Planned      | The request is accepted and expected to be built       |
| In Progress  | Work has started                                       |
| Completed    | The request has shipped                                |
| Closed       | The request will not be built or is no longer relevant |

<Tip>
  A smaller set of statuses is easier for users to understand and easier for your team to keep accurate.
</Tip>

## Build a roadmap from feedback

<Steps>
  <Step title="Review incoming posts">
    Read new feedback, merge duplicates when needed, and tag related themes.
  </Step>

  <Step title="Set priority">
    Use votes, comments, customer impact, and strategy to decide what deserves attention.
  </Step>

  <Step title="Assign ownership">
    Assign an internal owner so each planned item has a responsible team member.
  </Step>

  <Step title="Update status and dates">
    Move accepted work to `Planned` or `In Progress` and add a due date when you are ready to communicate timing.
  </Step>

  <Step title="Communicate changes">
    Add comments or changelog entries when important roadmap items move forward.
  </Step>
</Steps>

## Use due dates responsibly

Due dates help users understand when work may arrive, but they should be used only when your team has enough confidence.

Use due dates for:

* Committed roadmap work
* Beta launches
* Publicly announced releases
* Time-sensitive bug fixes

Avoid due dates for early ideas, exploratory work, or requests that still need product discovery.

## Public roadmap hygiene

Review roadmap items on a regular cadence.

* Keep `Planned` and `In Progress` items current.
* Remove or close stale work that no longer reflects your plan.
* Explain major changes in comments when dates or scope change.
* Publish a changelog entry when completed work ships.

## Next step

<Card title="Publish a changelog" icon="list-check" href="/guides/changelog">
  Use changelog updates to tell users what changed and close the feedback loop.
</Card>


# Voting and Prioritization
Source: https://help.suggix.com/guides/voting

Use votes, comments, tags, priority, and ownership to decide what to build next.

Voting helps you understand which requests matter to users, but votes should be one signal in your prioritization process rather than the only signal.

Use votes together with customer context, product strategy, effort, revenue impact, and support volume to decide what to build next.

## How voting works

When voting is enabled for a board, users can vote on posts they care about. Vote counts make demand visible to your team and to other users on the public portal.

Votes are useful for:

* Identifying popular feature requests
* Finding repeated pain points
* Comparing demand across related ideas
* Showing users that feedback is being considered

## Review high-signal feedback

Use this workflow during feedback triage:

<Steps>
  <Step title="Sort by vote count">
    Review posts with the strongest user demand first.
  </Step>

  <Step title="Read comments and details">
    Look for business context, workflows, affected user segments, and repeated use cases.
  </Step>

  <Step title="Apply tags and priority">
    Tag related themes and set priority for internal planning.
  </Step>

  <Step title="Update status">
    Move posts to the right status so users can see what is under review, planned, in progress, or complete.
  </Step>
</Steps>

## Use priority carefully

Priority is an internal planning signal. A highly voted request may still be low priority if it does not fit your product direction or requires disproportionate effort.

Good priority decisions usually consider:

* Number of affected users
* Severity of the problem
* Strategic fit
* Implementation effort
* Enterprise or key-account impact
* Dependencies and timing

<Note>
  Owner and priority information is intended for your team. Public users should see clear status and communication, not internal planning details.
</Note>

## Close the loop

When you update a post status, add a short comment explaining what changed. This builds trust and reduces repeated support questions.

Examples:

* `Planned`: Explain what problem you plan to solve.
* `In Progress`: Share what is being worked on without overpromising dates.
* `Completed`: Link to the release note or changelog entry when available.
* `Closed`: Explain why the request will not be built.

## Related guides

<CardGroup>
  <Card title="Roadmap and status" icon="map" href="/guides/roadmap">
    Turn prioritized feedback into a public roadmap.
  </Card>

  <Card title="Changelog" icon="list-check" href="/guides/changelog">
    Announce shipped changes and connect them back to user feedback.
  </Card>
</CardGroup>


# Introduction
Source: https://help.suggix.com/index

Collect feedback, plan your roadmap, and keep users informed — all in one place.

## Getting started

Suggix helps teams collect user feedback and ideas, organize them efficiently, and track their progress from concept to delivery. By keeping customers informed about product roadmaps and updates in real time, Suggix enables teams to build products driven by real user needs.

This documentation helps you set up your workspace, collect feedback, prioritize requests, publish roadmap progress, and connect Suggix to your product.

<Card title="Quick start" icon="rocket" href="/quickstart">
  Create your workspace, connect your site, and start collecting feedback in three simple steps.
</Card>

## Build with your users

Turn user feedback into clear priorities and transparent product progress.

<Columns>
  <Card title="Feedback management" icon="lift-ring" href="/guides/boards">
    Collect, organize, and prioritize user feedback in one centralized place.
  </Card>

  <Card title="Roadmap planning" icon="map" href="/guides/roadmap">
    Plan your product roadmap based on real user needs and share it with your community.
  </Card>

  <Card title="Changelog" icon="list-check" href="/guides/changelog">
    Publish product updates and keep users informed about what’s new and what’s coming next.
  </Card>
</Columns>


# Quickstart
Source: https://help.suggix.com/quickstart

Sign up, create your workspace, and complete the Suggix onboarding checklist.

This guide walks you through the first setup flow in Suggix: sign up, create a workspace, customize the workspace, create boards, share the portal, invite your team, and configure advanced options when needed.

## 1. Sign up

Open Suggix and create an account. You can continue with Google or sign up with email.

<img alt="Sign up to Suggix" />

After signing up, Suggix will guide you to create your first workspace.

## 2. Create a workspace

A workspace represents your product, project, or company feedback portal. All boards, posts, roadmap items, changelog entries, users, and settings belong to a workspace.

<img alt="Create a Suggix workspace" />

Enter:

* **Name**: The workspace name users and team members will see.
* **Subdomain**: The public portal URL, such as `https://new-project.suggix.com`.

<Tip>
  Choose a subdomain that is short, recognizable, and close to your product or company name. You can configure a custom domain later if your plan supports it.
</Tip>

## 3. Complete onboarding

After the workspace is created, Suggix opens the onboarding checklist. You can complete the steps in order or skip setup and configure these options later from Settings.

### Branding

Add your logo and brand color so the public feedback portal feels familiar to your users.

<img alt="Customize workspace branding" />

Branding affects:

* Workspace icon
* Public portal appearance
* Primary brand color
* User trust and recognition

You can update branding later in [Workspace General Settings](/settings/general).

### Boards

Create boards to organize feedback by topic or workflow.

<img alt="Create onboarding boards" />

Suggix suggests common board types such as:

* Bug Reports
* Wishlist
* Ideas
* Feature Requests

Start with a small number of boards. You can add, edit, or delete boards later in [Board Configuration](/settings/board).

### Share to users

Share your feedback portal link with users so they can submit feedback, vote on requests, and follow product progress.

<img alt="Share feedback portal with users" />

The onboarding step gives you:

* Your public feedback portal link
* A quick copy action
* A link to open the portal
* HTML you can embed on your website

Example website link:

```html theme={null}
<a
  href="https://new-project.suggix.com"
  target="_blank"
  rel="noopener noreferrer"
>
  Give Feedback
</a>
```

Place the link in your app navigation, account menu, help center, footer, or product emails.

### Invite team

Invite team members who should help review feedback, manage boards, update roadmap items, or publish changelog entries.

<img alt="Invite team members during onboarding" />

Enter a teammate's email address and send the invite. They will receive an email with instructions to join the workspace.

<Note>
  You can invite more team members later from the workspace user settings.
</Note>

### Custom domain

Use a custom domain if you want the public feedback portal to live under your own domain, such as `feedback.example.com`.

<img alt="Configure custom domain during onboarding" />

Custom domains are available on the Growth plan. If this step is not available on your current plan, you can continue onboarding and configure it later after upgrading.

For DNS setup details, see [Custom Domains](/development/custom-domains).

### Single Sign-On

Enable SSO if you want users to access Suggix through your existing authentication system.

<img alt="Configure SSO during onboarding" />

SSO works by:

1. Getting your SSO private key from Developer Settings.
2. Generating a JWT token on your server using user data.
3. Redirecting users to Suggix with the token so they are signed in automatically.

Use SSO when you want users to submit feedback, vote, and comment without creating a separate Suggix account.

For the full implementation guide, see [SSO Settings](/development/sso) and [Generate SSO Token](/development/jwt).

## What to do next

Once onboarding is complete, start using Suggix with your users:

<CardGroup>
  <Card title="Feedback Boards" icon="columns" href="/guides/boards">
    Learn how to structure boards for feature requests, bug reports, and ideas.
  </Card>

  <Card title="Voting and Prioritization" icon="arrow-up" href="/guides/voting">
    Use votes and context to decide what matters most.
  </Card>

  <Card title="Roadmap and Status" icon="map" href="/guides/roadmap">
    Turn feedback into a clear product roadmap.
  </Card>

  <Card title="Changelog" icon="list-check" href="/guides/changelog">
    Publish updates and close the feedback loop.
  </Card>
</CardGroup>

<Check>
  You can revisit skipped onboarding steps later from workspace settings.
</Check>


# Board Configuration Guide
Source: https://help.suggix.com/settings/board

Learn how to configure Boards in Suggix, including general settings, public view options, custom forms, tags, and deletion.

# What is a Board

In Suggix, a Board is the core unit for collecting and displaying user feedback. Each Board usually represents a specific feedback type, such as Feature Requests, Bug Reports, or Ideas.

Every Board has its own:

* Public URL
* Display rules
* Submission form
* Voting and interaction settings

<Info>
  A single workspace can contain multiple Boards to organize different kinds of feedback.
</Info>

<img alt="Suggix Board settings page showing general settings, public view options, custom form configuration, tags, and danger zone" />

## General Settings

### Board Name

The name of the Board shown in both the admin panel and the public feedback page.

* Example: `Feature Requests`
* Use a clear and descriptive name that reflects the Board's purpose

### URL

The public access path for this Board.

* Format: `https://your-workspace.suggix.com/{board-slug}`
* You only need to edit the slug, for example `feature-requests`

<Tip>
  If the Board is already shared publicly, avoid changing the URL to prevent breaking existing links.
</Tip>

### Description

A short description displayed at the top of the Board page to explain its purpose.

* Example: `Got an idea? We'd love to hear it!`

## Public View

These settings control how the Board is displayed and used by public users.

### Read-only

When enabled:

* Users can view existing posts only
* New posts cannot be created

This is useful for announcement Boards, public roadmaps, or archived feedback.

### Allow anonymous users to post

When enabled:

* Users can submit feedback without logging in
* Posts are marked as submitted by anonymous users

<Warning>
  Allowing anonymous posts may increase spam. Review public submissions regularly if this option is enabled.
</Warning>

### Show voters and comment likers

When enabled:

* Users can see who voted on a post
* Users can see who liked comments

Use this when public identity is important for community discussion. Disable it if you want voting and comment reactions to feel more private.

### Show votes count on posts

When enabled:

* Posts display their total vote count
* Users can quickly identify popular requests
* Your team can use votes as one input for prioritization

<Check>
  Once saved, these changes immediately affect the public Board view.
</Check>

## Custom Forms

Customize the text users see when creating a new post.

### Title Placeholder

Placeholder text for the post title input field.

* Example: `Briefly describe your idea`

### Details Placeholder

Placeholder text for the post details input field.

* Example: `Add more context, screenshots, or use cases`

### Button Text

The text displayed on the submission button.

* Example: `Create Post`
* Example: `Submit Feedback`

The live preview shows how the submission form will appear to users.

<Tip>
  Clear placeholder text significantly improves the quality of submitted feedback.
</Tip>

## Tags

Tags help categorize and filter posts within a Board.

* Click **Add Tag** to create new tags.
* Use tags for feature areas, priority levels, product modules, or customer segments.
* Examples: `UI`, `API`, `High Priority`, `Enterprise`

<Info>
  Consistent tag usage makes feedback easier to manage and analyze over time.
</Info>

## Danger Zone

### Delete Board

Permanently deletes the Board.

<Warning>
  Deleting a Board is irreversible:

  * All posts, comments, and votes will be permanently removed.
  * The public URL will stop working immediately.
</Warning>

Make sure the Board is no longer needed before deleting it.


# Workspace General Settings
Source: https://help.suggix.com/settings/general

Configure basic information and branding for your Suggix workspace

The **General** settings allow you to configure your workspace’s identity, branding, and public-facing information.\
These settings affect how your workspace appears across the dashboard and public feedback portal.

<img alt="General Settings" />

## Properties

<ResponseField name="icon" type="image">
  Workspace icon displayed in the dashboard, workspace switcher, and the header of your public feedback portal.
  This icon is shown alongside the workspace name in the feedback site header.

  * Recommended size: `192 × 192` pixels
  * Maximum file size: `1MB`
</ResponseField>

<ResponseField name="favicon" type="image">
  Favicon used in browser tabs for your public feedback portal.

  * Recommended size: `512 × 512` pixels
  * Maximum file size: `1MB`
</ResponseField>

<ResponseField name="name" type="string">
  The display name of your workspace.

  This name appears in the dashboard, public feedback portal, and notifications.

  Example: `Suggix`
</ResponseField>

<ResponseField name="subdomain" type="string">
  The subdomain used for your public feedback portal.

  Your portal will be accessible at:

  `https://{subdomain}.suggix.com`

  Example: `suggix`

  Changing the subdomain changes the public portal URL. Update any links in your product, help center, or emails after changing it.
</ResponseField>

<ResponseField name="brand_color" type="string">
  Primary brand color used on your public feedback portal.

  This color is applied to buttons, highlights, and key UI elements to match your brand identity.

  Example: `#5B6CFF`
</ResponseField>

<ResponseField name="announcement" type="string">
  A public announcement displayed at the top of your feedback portal.

  Use this to share important messages, guidelines, or updates with your users.

  Example:
  `Please create feature requests in this section to share your ideas and help us improve the product.`
</ResponseField>

## Public portal URL

Your workspace is available at:

```text theme={null}
https://{subdomain}.suggix.com
```

If you configure a custom domain, users can also access the same portal through your branded domain. See [Custom Domains](/development/custom-domains).

## Branding checklist

Before sharing your portal publicly, confirm that:

* The workspace name matches your product or company name.
* The icon and favicon are uploaded.
* The brand color has enough contrast for buttons and links.
* The announcement text gives users clear submission guidance.
* The public URL is correct.

<ResponseField name="hide_powered_by" type="boolean">
  Hide the **Powered by Suggix** branding on your public feedback portal.

  > Available on the **Business** plan only.

  Example: `false`
</ResponseField>

## Danger Zone

<ResponseField name="delete_workspace" type="action">
  Permanently deletes the workspace and all associated data.

  ⚠️ This action is **irreversible**.\
  All boards, posts, members, and settings will be permanently removed.
</ResponseField>