Riverd
Features→API keys
Platform

Connect the apps you already use to your practice.

Make an API key in Riverd and paste it into an app you choose. A spreadsheet can pull in your week, or an automation tool can add new clients from your sign-up form. You decide whether each key can only look or can also make changes.

Start your practice freeSee pricing

No credit card required

  • Choose what each key can do: read only, or read and make changes like booking, moving and cancelling sessions.
  • Undo what an app did from your API keys page, for 5 minutes, or 24 hours for time off and session notes.
  • Emails and texts to your client wait until the Undo time passes, or until the session starts if that's sooner.
  • Riverd emails you the first time each key makes a change, and you can turn a key off any time.
  • On every plan, including Brook, the free plan.

Choose what each key can do

Each key is Read only or Read and make changes. A read-only key sees your schedule, weekly hours, clients, services, open times, time off, session notes, intake form names and intake answers, and can't change anything. A key that can make changes can also book, move and cancel sessions, add clients, email a client an intake form, block time off and write session notes. Give each app its own key, named so you can tell them apart. A spreadsheet that shows your week only needs Read only; an automation tool that adds clients from your sign-up form needs to make changes.

Changes happen right away, and you can undo them

A change an app makes shows up in Riverd right away. You can undo it for 5 minutes, or 24 hours for time off and session notes: go to Settings, API keys, and select Undo next to it under Changes you can still undo. Each change there shows what the key did, when, and which key did it. Emails and texts to your client about a change, like a booking notice, wait until those 5 minutes pass, so if you undo it in time, your client never gets that email or text. A notice for a session that starts sooner than that goes out when the session starts.

An email the first time a key makes a change

The first time each key changes something, Riverd emails you what it did and when, like "booked a session". If you or an app you set up made the change, there's nothing to do. If not, turn the key off and undo its recent changes on the same page. Riverd also emails you every time a key is made on your account, and the first time a key reads a list of your session notes or intake answers.

Overlapping times are refused

If an app tries to book or move a session onto a time that overlaps another session, a busy time on your Google Calendar or your time off, Riverd refuses it and tells the app what's in the way. If you want the overlap, tell the app to book it anyway. A session an app books shows up in your connected Google Calendar like one you booked yourself.

Turn a key off any time

Select Turn off next to a key, and anything using it stops getting your data and making changes right away. What it already changed stays in Riverd, and you can still undo recent changes. A key also stops on the date you picked, and after 90 days without use, unless you set it to Never when you made it. Every key stops when you change your email address or phone number, or when you select Sign out everywhere. Riverd shows each key to you once, so keep it somewhere safe, like a password manager.

For whoever sets up the app

If someone sets the app up for you, send them to the developer docs. They list every request a key can make, the limits and the errors, and link to the full OpenAPI document.

Frequently Asked Questions

Which plans include API keys?+
Every plan, including Brook, the free plan. River and Fjord include them too, with the same limits.
Do I need to be technical to use an API key?+
No. You make a key in Settings, API keys, then paste it where the app asks for it, or give it to whoever sets the app up for you. If the app only needs to look at your practice, choose Read only.
Can I undo something an app did?+
Yes, for a while. Bookings, moves, cancellations, logged sessions, intake forms, new clients and confirmed contact details can be undone for 5 minutes, and time off and session notes for 24 hours. Go to Settings, API keys and select Undo next to the change under Changes you can still undo. After that, change it back in Riverd the way you usually would.
Will my clients hear about changes an app makes?+
Yes, for the changes they usually hear about: a booking, a move or a cancellation gets the usual notice, and an intake form is emailed. That message waits for the 5 minutes you have to undo the change, or until the session starts if that's sooner, so if you undo it in time, your client never gets it. Adding a client, blocking time off, writing notes and logging a past session send your client nothing.
What happens when an app adds a new client?+
Riverd sends them nothing until their email address and phone number are confirmed. The app should read the details back to you first, and if you say they're right, it can save them as confirmed. Otherwise you can confirm them on the client's page with Yes, it's right. If a booking notice for them comes due before that, Riverd skips it, so let the client know about the session yourself.
What can't an app do with a key?+
A key can't change payments, refunds, your plan or your API keys, and it can't cancel a session that has started or that you've been paid for. It can book or move a session up to 24 months ahead; to book further out, book it in Riverd yourself.
How do I keep a key safe?+
Treat it like a password: anyone who has it can see your clients, sessions, session notes and intake answers until you turn it off. Paste it only where the app asks for it, never in an email, a text or a web address. Riverd stores each key only as a one-way hash, shows it to you once, and turns off a key that is sent to Riverd in a web address. If you think someone else has a key, turn it off and undo anything you don't recognize.
Can an app use Reed, Riverd's AI, on my notes?+
Only if you turn on Can start Reed · AI on notes when you make the key. The app can then ask Reed to draft a SOAP note from one session's notes. The draft goes back to the app and nothing is saved in Riverd. Each draft uses your AI credits, every run is listed under the key, and you can turn it off for a key at any time.

By the Riverd teamLast updated

Ready to try API keys?

Join Riverd and start using this feature today, no credit card required.

Start FreeView All Features