Skip to main content

How To Integrate Appointedd Solution As a Booking System

Requirements
  • API Key To create an API key, navigate to your BamHub -> Settings -> Integrations -> API Keys. Required scope is APPOINTED_BOOKINGS_WEBHOOK. This will enable you to make http requests to our REST API.

Step 1: Configure your Appointedd account​

If you're new to Appointedd, you can find a collection of helpful articles here on how to get start with Appointedd.

In order to utilise the Appointedd x Bambuser integration, we recommend the below configuration as a minimum:

Create resources in appointedd​

Resources are what your Bambuser Agent's are going to connect to. Therefore in the context of Bambuser we recommend that you have one resource per agent.

It is also possible for two or more agents to share the same resource, but then they will have to manually communicate with each other who will attend each meeting as they will all see the same meetings in the Bambuser Agent Tool.

Create services in appointedd​

A Service is what your customers will book, for example "Virtual Consultation". For each service you need to assign resources that can provide the service. Appointedd will manage the availability and make sure that when customers book a service the booking will be assigned to one of the available resources within that service.

Microsite, popover or embed​

Configure your microsite, popover or embedded widget to how you want it to look like. You can adjust these to suit your brand or existing website and then add them to your website and/or promote your new online booking tools.

Step 2: Customise the automated communications your customers receive​

In the booking confirmation email you will need to include the unique Bambuser link with an Appointedd variable for customers to be redirected to your site where they will meet up with the booked resource.

You can set this up easily by utilising the Advanced communication feature of Appointedd. We recommend including the joining URL in the confirmation modification & reminder emails.

Once you have Advanced communications turned on for each communication template you'd like to include the Bambuser link in, adjust the content as you'd like, and add the appropriate URL. This URL should be in the following format, and look something like this:

https://your-website/your-live-meeting-page/?bambuserConnectId=ext:{{booking_id}}

Step 3: Customise the automated communications your resources receive​

Your resources will be able to start the virtual meetings from Bambuser workspace, but if you'd like them to receive the joining URL in the resource confirmation email as well, please get in touch with team Appointedd to action this. They will need your resource/agent joining URL for this, which will follow the below format:

https://lcx.bambuser.com/[BAMBUSER_ORG_ID]/one-to-one/agent-tool/?connectId=ext:{{booking_id}}

Step 4: Sync Appointedd bookings into Bambuser​

In order to ensure that all bookings created in your Appointedd account appear in your Bambuser workspace, you'll need to set up webhooks in Appointedd. You can learn more about how to set these up here.

For this connection specifically, you'll need to create a booking_created, booking_updated and booking_cancelled webhook with the same settings:


  • In your Appointedd account go to integrations > webhooks and click add webhook
  • Name webhook to make it easily identify-able, this could be anything
  • Select webhook trigger which will be booking_created
  • Under URL, add the Bambuser API endpoint: https://liveshopping-api.bambuser.com/v1/bookings/appointeddWebhook
  • Then add the authorization header with the API key you have received from your Bambuser contact
  • Repeat this process for booking_updated and booking_cancelled

Your Bambuser Agents will need to be connected to their corresponding Appointedd resource. We provide two ways of doing this, with a Resource picker or just a plain Text field on the Agent's profile page. We recommend the Resource picker as it is the smoothest and easiest user experience for the Agents.

Requirements
  • Appointedd API Key You will need to send an Appointedd API key to your Bambuser contact. You can find your Appointedd API key in your Appointedd admin tool under Integrations menu.

  • Share your Appointedd API key with your Bambuser contact
  • The Bambuser contact will activate the resource picker for your workspace
  • After activation, Agents can now go and pick their Appointedd Resource on their profile page in Bambuser Workspace

Step 6: Enable bookings directly from the Bambuser Calls Widget (Optional)​

Bambuser can enable Book a meeting button in the Calls Widget. You can select in between three different behaviours when clicking on the button.

requirement

To configure this, you should navigate to Bambuser workspace -> Configurations -> Integrated Booking Widget. In there you should provide:

  • URL to your booking interface page
  • Which of the below option you will opt in
OptionBehaviourDescription
1IframeBooking URL page opens in an iframe inside the Calls Widget. If you are using this option, your booking page should be responsive on mobile devices!
2New TabBooking page URL will open in a new tab and widget will remain open in the old tab
3RedirectBooking page URL will open in the same tab and force widget to close.