Docs

Referral Rock API Authentication

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

Every Referral Rock API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Referral Rock 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 Referral Rock connection in Connections. Referral Rock 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 Referral Rock account that should run the action. MindCloud stores and refreshes the Referral Rock 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 Programs with an Referral Rock connection looks like this:

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

Get your Referral Rock API keys

You need a Referral Rock account with access to Settings > Integrations.

  1. Open the API Keys page

    In Referral Rock, go to Settings > Integrations and select Manage API Keys under Libraries.

    Settings → Integrations → Manage API Keys
  2. Create a new API key

    Select Add API Key and enter a nickname for this MindCloud connection.

  3. Copy the credentials immediately

    Copy the Public Key and Private Key when they are first shown. Referral Rock only shows the Private Key and Basic Auth key once.

  4. Enter the keys in MindCloud

    Use the Public Key as the username and the Private Key as the password in the MindCloud Basic Authentication form.

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.