How do I give my web developer an API key?
Create a key under Booking page, Developers, and send it to your developer privately. The key is shown once, so copy it before you close the window.
Most websites do not need a key. The booking link, the embed and the widget all work without one.
Your developer needs a key only to:
- book consults your clinic pays for through our booking API
- send questionnaire answers from your own website or systems
- Open Booking page, open More settings and choose Developers.
- Under API keys, choose Create key.
- Give it a name that says what it is for, such as the website or the agency.
- Copy the key straight away. It is shown in full only once.
- Send it to your developer privately, for example in a password manager. Do not paste it into an email thread or a chat with other people.
The key belongs on your developer's server. It must never go into your website's page code, because anyone could read it there.
A key works only for your clinic's booking pages. If a key is lost, shared by mistake or no longer needed, choose Revoke next to it. It stops working straight away, and anything using it stops too. Create a new key if you still need one.
The same tab has Webhooks, which send booking events such as a new booking or a cancellation to your own systems. They never carry questionnaire answers or clinical notes.
Only a clinic manager can create or revoke keys.