Appointedd booking widgets can be generated “on the fly” by building up a URL with required parameters, and the client ID of your Appointedd account.  This can be used to start customized booking journeys from within your application.

URL format

The following is an example of the URL format required:

https://book.appointedd.com/app/dynamic/{CLIENT_ID}?{PARAMETERS}

{CLIENT_ID} should be replaced with the Client ID of your Appointedd account, which can be found from within the API settings.

{PARAMETERS} should be replaced with URL parameters that match the customized booking journey you are looking to generate.  A list of URL parameters can be seen below.

If using multiple {PARAMETERS}, they should be formatted as follows:

https://book.appointedd.com/app/dynamic/{CLIENT_ID}?service={SERVICE_ID}&bookable={RESOURCE_ID}&groups={RESOURCE_GROUP_IDS}

URL parameters

Dynamic booking widgets support the following URL parameters:

service – a service ID.  This opens the booking journey locked to a single service.
bookable – a resource ID.  This opens the booking journey locked to a single resource.
colour1 – a URL encoded Hex code.  This changes the colour shown in the header of the booking widget journey.
colour2 – a URL encoded Hex code.  This changes the colour shown on the button inside the booking journey.
embedded – a boolean.  If the booking journey is being loaded within an embedded iFrame, set this value to true. This ensures the booking journey stretches to fit the container. If the booking journey is being loaded as a modal popup, set this to false.

groups - one or multiple resource group IDs, separated by commas. This opens the booking journey locked to the selected resource group(s).

Did this answer your question?