Getting Started

Welcome to the Rockbot Developer Portal. To get started, first reach out to support@rockbot.com with the subject line Rockbot API Access Request and include a link to your Dashboard in the email, as well as which functionality 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 your access has been approved, you will receive an email with your CLIENT_ID and a one-time link to retrieve your CLIENT_SECRET. Your credentials will be limited to the scopes 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.
Do not 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 that will be used 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 will be valid for 24 hours, and must be refreshed before it expires

Continue to the Rockbot API Reference.

Limits

By default, your API client will be limited to 1 request per second. HTTP Cache-Control headers should be respected to reduce unnecessary requests to the API. Please contact support@rockbot.com if your application requires a higher request limit.