Docs

Comm100 API Authentication

How to authenticate Comm100 API requests: one Bearer API key plus a connectionId. MindCloud stores your Comm100 credentials — no auth headers to build.

Every Comm100 API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Comm100 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 Comm100 connection in Connections. Comm100 uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
  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 Comm100 account that should run the action. MindCloud stores and refreshes the Comm100 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 Agent Statuses with an Comm100 connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/comm100/actions/list-agent-statuses/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 Comm100 account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Comm100 with API Key Authentication

You need a Comm100 agent login, that agent's API key, and the Comm100 site ID for the target workspace.

  1. Sign in to the Comm100 Control Panel

    Open your Comm100 Control Panel and sign in with the agent account you want MindCloud to use for API access.

  2. Copy the agent email and API key

    In the bottom-left navigation area, open the avatar menu and click the agent name. In the My Profile drawer, expand More Information and copy the login email and API key for this agent.

  3. Copy the Comm100 site ID

    In the Comm100 Control Panel, go to Global Settings > Site Profile and copy the Site ID from that page.

  4. Enter the connection values in MindCloud

    When creating or updating the MindCloud test connection, enter the agent email as the username, the Comm100 API key as the password, and the Site ID in the Site ID field.

  5. Run the test connection

    Use the MindCloud connection test after saving the credentials. Comm100 API-key authentication requires both Basic Auth credentials and siteId on API requests.

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.