API and AI tools: connect your software and AI assistant
Use the Developers page to make your API key, read the API docs, connect an AI assistant through MCP and send events to your own server with webhooks.
The Developers page lets you connect your own software, such as a booking system, a CRM, a till or your own code, and AI assistants to your account. It's for you or whoever looks after your systems; you don't need it to use the app day to day.
If you don't see Developers in your menu, API access isn't part of your plan — Raving Reviews can tell you about adding it.
Your API key
Your account has one API key with full access to your account: everything in the API and your AI connector. Anything that holds the key can read and change your data, so keep it as safe as a password.
To create your key:
- Open Developers.
- Under API key, click Create API key.
- Copy the key from Your new key straight away and keep it somewhere safe. You won't be able to see it again.
- Click Done.
Next to the new key you'll also see an example request and your AI connector (MCP) address.
After that, the key is shown by its last few characters only, with who made it (your team or Raving Reviews), when it was created and when it was last used.
- Make a new key replaces it. The old key stops working straight away, so update anything that uses it. Do this if your key is ever shared by mistake.
- Revoke switches the key off completely.
The Base URL at the top of the card is the address your software sends its requests to; Copy puts it on your clipboard.
Only the account owner can make or revoke keys. If you see a note saying so, ask the account owner or Raving Reviews.
Read the docs
Click Read the docs for the full reference: every request your key can make, grouped by area (such as contacts, reviews and review requests), with the exact request for each. On a request's page, Try it lets you send a test, either to a demo account (nothing is saved or sent) or with your own key. Download OpenAPI gives you a file that developer tools can read.
Connect an AI assistant (MCP)
Your key also works as an AI connector. Many AI assistants let you add a custom connector using MCP (Model Context Protocol). Once it's connected, the assistant can use everything in the API for your account, so you can ask it things like how many enquiries came in last month, or ask it to send review requests.
- Copy the AI connector (MCP) address shown when you create your key. It's your connector address with your key on the end.
- In your AI assistant, add a custom connector and paste the address. The note under the address explains where to find this in a popular assistant.
The address contains your key, so keep it private. If you made your key earlier, the card shows the connector address followed by ck_…: put your full key in place of that ending. If you no longer have your key, make a new one.
Webhooks
Webhooks send events to your own server as they happen, such as new reviews, enquiries, leads and contacts. Each delivery is signed, so your server can check it really came from your account.
- Under Webhooks, click Add webhook.
- Enter your Endpoint URL and choose the Events you want, or All events (which includes events added later).
- Click Add webhook, then copy Your signing secret and keep it on your server. You won't be able to see it again.
For each webhook you can Send test, open the Delivery log to see each delivery and retry a failed one, Switch off, Rotate secret or Delete it. How webhooks work explains the details for your developer.
Common questions
Is my API key the same as my password? No. The key is only for software and AI tools. Signing in to the app always uses your email and password.
What happens to my key if my plan changes? Your key only works while your plan includes API access.
Can Raving Reviews make a key for me? Yes. A key made by Raving Reviews shows their name as the maker.
Still stuck?
Get in touch with Raving Reviews and we'll help you out.
Related articles
- Sign in and keep your account secureHow to sign in, reset a forgotten password, change your email or password, and simple ways to keep your account safe.
- Contacts: your customer listAdd customers one at a time or import a spreadsheet, find anyone quickly, and see where each person is with a review request.
- Connect your accounts on Apps & setupWhat to connect on the Apps & setup page, why it matters, and where each of your other tools is set up.
- Privacy and your dataWhat your account stores about your business and customers, how customers' opt-outs are recorded and respected, and how to get data out or deleted.
