Getting started

Welcome to the Rockbot Developer Portal. To get started, first reach out to [email protected] with the subject line Rockbot API Access Request and include a link to your Dashboard in the email, as well as which features you'd like to access via the Rockbot API. The email must be from the same account tied to your Rockbot user.

Authentication

The Rockbot API authenticates via the OAuth 2.0 Client Credentials grant.

Client secret

Once Rockbot approves your access, you receive an email with your CLIENT_ID and a one-time link to retrieve your CLIENT_SECRET. Your credentials only grant access to the scopes you requested.

https://api.rockbot.com/v5/api-clients/CLIENT_ID/secret?one_time_code=XXXXXXXX

WARNING

This secret is only visible once, so store it somewhere confidential immediately after retrieval.
Don't share this code publicly or check it into source control.

Access token

Use your CLIENT_ID and CLIENT_SECRET to obtain a temporary ACCESS_TOKEN to authenticate API requests via Bearer Authentication

Request

curl -X POST https://api.rockbot.com/v5/api-clients/token \
-H  "Content-Type: application/json" \
-d '{ "client_id": "CLIENT_ID", "client_secret": "CLIENT_SECRET" }'

NOTE

Your access token is valid for 24 hours. Refresh it before it expires.

Continue to the Rockbot API Reference.

Limits

By default, your API client can make 1 request per second. Respect HTTP Cache-Control headers to reduce unnecessary requests to the API. Please contact [email protected] if your app requires a higher request limit.