Docs

OneSignal API Authentication

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

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

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

Connect your OneSignal app

You need access to the OneSignal app you want to connect.

  1. Open your app's Keys & IDs page

    Sign in to OneSignal, open the app you want to connect, then go to Settings > Keys & IDs.

    Settings → Keys & IDs

  2. Copy the App ID

    Copy the App ID shown on the Keys & IDs page. OneSignal documents this as the identifier used for app-level API requests such as Create message and Create user.

  3. Create or copy an App API key

    On the same Keys & IDs page, click Add Key if you need a new key, enter a descriptive name, optionally configure IP allowlisting, click Create, then copy the key immediately.

  4. Paste both values into MindCloud

    Return to MindCloud and enter the App ID and App API key for this connection.

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.