Sign inGet started
Docs
Get started

SupportBee API Authentication

How to authenticate SupportBee API requests: one Bearer API key plus a connectionId. MindCloud stores your API key securely — set it once, never resend it.

Every SupportBee API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your SupportBee account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a SupportBee connection in Connections. SupportBee uses an API key. You generate the key in your SupportBee account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected SupportBee account that should run the action. MindCloud stores and refreshes the SupportBee credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Tickets with an SupportBee connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/supportBee/actions/list-tickets/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which SupportBee account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect your SupportBee desk

You need the URL of the SupportBee desk you want to connect and an API token from that same desk.

  1. Open your SupportBee desk

    Sign in to the SupportBee desk you want to connect. The desk URL looks like https://your-company.supportbee.com.

  2. Open API Token

    Click your profile picture in the top-left corner, then click "API Token".

  3. Copy your API token

    Copy the API token shown by SupportBee.

  4. Find your company subdomain

    Copy only the subdomain from your desk URL. For https://your-company.supportbee.com, enter your-company as the company value.

  5. Enter both values in MindCloud

    Paste the API token into the API key field and the subdomain into the company field.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.