REST Keys

If you or your team plan to interact with Rock's API, you'll need to set up a REST Key first. REST Keys are how Rock authenticates external applications and scripts making API calls. Without one, those calls will be rejected before they can do anything useful.

You can manage REST Keys at Admin Tools > Setting > REST Keys. To create one, select the Add button and fill out the REST Key Details:

  • Name — Give the key a clear name so you know what it's for (e.g., "Giving Platform Integration").
  • Description — Optional, but useful if you manage multiple keys.
  • Key — Rock pre-generates a token for you. Select Generate Key if you'd like a new one.
  • Active — Check this box or the key won't work.

Copy the key token before you leave the page. You'll pass it with each API request as an authorization header so Rock knows who's making the call and what they're allowed to do.