• Documentation >
• Apps >
• Productivity >
• SimplyBook.me

SimplyBook.me

With SimplyBook.me modules in Ibexa Connect, you can:

• watch, create, update, search, and cancel bookings, create a booking's comment, and retrieve booking details and links

• create, update, retrieve, search, and delete clients

• create, update, retrieve, search, and delete notes

• search and retrieve available slots

• create and retrieve reports

• search and retrieve invoices

• apply a promo code

• issue a gift card

• accept a payment

To get started with SimplyBook.me, create an account at simplybook.me

Connect SimplyBook.me to Ibexa Connect

To connect SimplyBook.me app:

1. Log in to your SimplyBook.me account.

2. Log in to your Ibexa Connect account, insert a SimplyBook.me module in your scenario, and click the Add button next to the Connection field.

   

3. In the Connection name field, enter a name for the connection.

4. In the Company fields, enter your company name.

5. In the Login, and Password fields, enter your account credentials and click Save.

You have successfully established the connection. You can now begin editing Ibexa Connect and adding more Simplybook.me modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Bookings

You can watch, create, update, search, and cancel bookings, create a booking comment, and retrieve booking details and links using the following modules.

Watch Booking Events

Triggers on booking events.

Webhook name	Enter a name for the webhook.

See the Setting Up SimplyBook.me Webhooks to set up the booking events webhooks.

Create a Booking

Creates a new booking.

For field descriptions, see the SimplyBook.me Bookings API reference.

Update a Booking

Updates an existing booking.

Booking ID	Select or map the Booking ID whose details you want to update.

For field descriptions, see the SimplyBook.me Bookings API reference.

Create a Booking Comment

Creates a comment for booking.

Booking ID	Select or map the Booking ID whose comment you want to create.
Booking Comment	Enter the comment you want to add.

Get Booking Details

Gets booking's detailed info.

Booking ID	Select or map the Booking ID whose details you want to retrieve.

Get Booking Links

Gets booking links.

Booking ID	Select or map the Booking ID whose links you want to retrieve.

Search Bookings

Searches for bookings or lists them all.

Limit	Set the maximum number of bookings Ibexa Connect will return during one execution cycle. The default value is 10.

See SimplyBook.me Bookings API reference for entering the field values to search the bookings that match the specified value.

Cancel a Booking

Cancels an existing booking.

Booking ID	Select or map the Booking ID you want to delete.

Clients

You can create, update, retrieve, search, and delete clients using the following modules.

Create a Client

Creates a new client.

For field descriptions, see the SimplyBook.me Clients API reference.

Update a Client

Updates an existing client.

Client ID	Select or map the Client ID whose details you want to update.

For field descriptions, see the SimplyBook.me Clients API reference.

Get a Client

Retrieves an existing client.

Client ID	Select or map the Client ID whose details you want to retrieve.

Search Clients

Searches for clients or lists them all.

Search	Enter the parameters to search for clients.
Limit	Set the maximum number of clients Ibexa Connect will return during one execution cycle. The default value is 10.

Delete a Client

Deletes an existing client.

Client ID	Select or map the Client ID you want to delete.

Notes

You can create, update, retrieve, search, and delete notes using the following modules.

Create a Note

Creates a new note.

For field descriptions, see the SimplyBook.me Notes API reference.

Update a Note

Updates an existing note.

Note ID	Select or map the Note ID whose details you want to update.

For field descriptions, see the SimplyBook.me Notes API reference.

Get a Note

Retrieves an existing note.

Note ID	Select or map the Note ID whose details you want to retrieve.

Search Notes

Searches for notes or lists them all.

Limit	Set the maximum number of notes Ibexa Connect will return during one execution cycle. The default value is 10.

See SimplyBook.me Notes API reference for entering the field values to search the notes that match the specified value.

Delete a Note

Deletes an existing note.

Note ID	Select or map the Note ID you want to delete.

Slots

You can search and retrieve available slots using the following modules.

Get the First Available Slot

Retrieves the first available slot.

For field descriptions, see the SimplyBook.me Slots API reference.

Search Available Slots

Searches for available slots or lists them all.

Limit	Set the maximum number of available slots Ibexa Connect will return during one execution cycle. The default value is 10.

See SimplyBook.me Slots API reference for entering the field values to search the slots that match the specified value.

Reports

You can create and retrieve reports using the following modules.

Create a Detailed Report

Creates a new detailed report.

For field descriptions, see the SimplyBook.me Reports API reference.

Get a Report

Retrieves an existing report.

Report ID	Select or map the Report ID whose details you want to retrieve.

Invoices

You can search and retrieve invoices using the following modules.

Get an Invoice

Retrieves an existing invoice.

Invoice ID	Select or map the Invoice ID whose details you want to retrieve.

Search Invoices

Searches for invoices or lists them all.

Limit	Set the maximum number of Invoices Ibexa Connect will return during one execution cycle. The default value is 10.

See SimplyBook.me Invoices API reference for entering the field values to search the contacts that match the specified value.

Promo Codes

You can apply promo code notes using the following modules.

Apply a Promo Code

Applies an existing promo code.

Invoice ID	Select or map the Invoice ID whose promo code you want to apply.
Promo Code	Enter the promo code you want to apply. For example, tapyjuju

Gift Cards

You can issue a gift card using the following modules.

Issue a Gift Card

Issues an existing gift card.

Gift Card ID	Select or map the Gift Card ID you want to issue.

For field descriptions, see the SimplyBook.me Gift Cards API reference.

Payments

You can accept payment using the following modules.

Accept a Payment

Accepts a payment.

Invoice ID	Select or map the Invoice ID whose payment you want to accept.
Payment Processor	Enter the payment method, for example, manual.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the SimplyBook.me API documentation.

URL	Enter a path relative to, https://user-api-v2.simplybook.me. For example: /admin/clients.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - Search Clients

The following API call returns all clients from your account.

URL: /admin/clients

Method: GET

The search matches can be found in the module's Output under Bundle > Body > data.

In our example 6 clients were returned:

Setting Up SimplyBook.me Webhooks

To set up the SimplyBook.me webhooks:

1. Open any watch Booking Events modules, click Add, enter a name for the webhook, click Save and copy the URL to your clipboard.

   

2. Log in to your SimplyBook.me account, click Custom Features, and enable the API.

   

3. Enable the required triggers, in the Callback URL field, enter the URL address copied in step 1, and click Save.

   

You have successfully set up the webhooks and will receive the triggers when the specified events occurs.