Skip to main content
Linking SimplyBook.me gives the agent your company’s services and staff, the next free day and its time slots, and the ability to create and cancel bookings, on the web widget and every other channel. There is no self-serve connection: you collect three values from SimplyBook.me and support links them to your agent. Verified against lua-cli 3.33.0. Before you begin
  • A SimplyBook.me account with the API custom feature available on its plan.
  • The agent to link, and its agent ID from the admin dashboard.
1

SimplyBook.me: find your company login

Sign in at simplybook.me, open the account menu, and select Account Info. The Company Login is the identifier in your booking URL (<company>.simplybook.me).
SimplyBook.me Account Info showing the Company Login

Company Login on the Account Info page.

2

SimplyBook.me: switch on the API and generate keys

In Custom Features, switch API on, then generate an API key; note both the API key and the secret key.
Enabling the API custom feature

The API toggle under Custom Features.

Generate New API Key

Generating the API key.

3

Send the values to support

Email [email protected] with the company login, API key, secret key, and the agent ID. Support links them to the agent; from then on Lua signs in to the SimplyBook.me API itself and refreshes the token on a schedule.
4

Try it

On the web widget or a connected channel, ask “When is the first free slot for a 30-minute massage?”. The agent lists services and staff, finds the first working day, offers time slots, and books once the end user gives a name, email address, and phone number.

​
What the agent can do

  • Read the company’s details and settings.
  • List services and list staff members.
  • Find the first working day for a service and staff member, and the free time slots between two dates for a service, staff member, and number of seats.
  • Create a booking with the end user’s name, email address, and phone number, optionally with extra fields, a group count, or recurring data.
  • Cancel a booking using its ID and the hash returned when it was created.
Rescheduling is a cancellation followed by a new booking.

​
Raw API access

SimplyBook.me isn’t a Unified.to integration type, so there is no Integrations.passthrough('simplybook', …). For endpoints the tools don’t cover, write a tool that calls the SimplyBook.me API with your own keys from env() (see Call your API). To add your own tools to this agent, run lua init --agent-id <id> in a new folder (find the ID with lua agents --json --ci), then follow Add a tool.

​
Limits

  • One SimplyBook.me company per agent.
  • Every booking needs a name, an email address, and a phone number.
  • A cancellation needs the booking’s hash, which the agent holds for bookings it created in the conversation.

​
If it isn’t working

The values haven’t been linked to this agent, or the company login or API key is wrong. Check them in SimplyBook.me and send them to [email protected] again with the agent ID.
The service has no staff member assigned, or the staff member has no working hours in that range. Assign the service and set working hours in SimplyBook.me.
SimplyBook.me rejected the booking: the API feature was switched off, or the email address or phone number isn’t in a format it accepts. Re-enable the API and ask the end user to confirm the contact details.

​
Next steps

Send proactive messages

Reminders the agent sends before an appointment.

Channels

Take bookings on WhatsApp, Instagram, and Messenger.

About the persona

Shape how the agent offers services and confirms bookings.

Square Appointments

The same booking flow on Square.