Here’s what you need to know

  • In this article we dive deep, and show you how to make customisations that deliver really impressive results. We give you the script you need to do things like change the colour of your widget overlay, pre-select a service, or pre-fill customer details.

 Here's how the article is structured:

  1. Customisation options for a booking widget overlay
  2. Customisation options for a booking widget as iFrame or direct link
  3. Customisation options using our REST API

Scroll down to your preferred option and we'll walk you through the customisations we offer:

1. Customisation options for a booking widget overlay

STEP 1:

In TIMIFY, go to Integration -> Booking Widget -> Booking Button/Overlay, and select “flexible position”.

STEP 2:
The flexible position doesn’t include the "data-id" attribute, as your booking ID lies within the HTML element that you have just defined as your booking button.

As you’re going to edit the appearance and positioning of the button, the parameter "data-position" needs to have the value “flexible".

Paste the snippet code right before the </head> or the </body> tag of your template.


STEP 3:
Now let's define the HTML element on your website that allows the browser to open the widget. You usually have one of the following HTML elements:

However, you can choose any other HTML tag for your button. Please always note that you need to:

  • add a class "timify-button" for the element to which the snippet refers
  • add the attribute "data-account-id=" with your TIMIFY booking ID within the ""

Attributes you can add to your code to customise the widget and/or the booking workflow

Use the below list of attributes (we’ve added handy explanations!) to adjust your widget, so that you can make it appear exactly how you like. Attributes can be integrated into existing buttons as follows.

Let's say you would like to pre-select a service when a certain booking button on your page is clicked. In this case you would have to put the attribute data-service-id="5f6cbdb98e434611ef5bbf73" to your button element:

<div class="timify-button" data-account-id="5f6cbd042e148e11ac2acaad" data-service-id="5f6cbdb98e434611ef5bbf73">Book a massage</div>


If you would like to pre-select a service globally for all your buttons via your JavaScript code then simply add the attribute to the TIMIFY JS snippet:

<script async
src="//book.timify.com/widget/widget.min.js"
id="timify-widget"
data-position="flexible"
data-account-id="5f6cbd042e148e11ac2acaad"
data-service-id="5f6cbdb98e434611ef5bbf73">
</script>

Here is a list with all supported attributes for the TIMIFY booking widget integration as an overlay:

1.1 General and layout related attributes

Attributes

Description

Example

data-account-id

Use this to load your account or a specific branch to the widget.

data-account-id="5f6cbd042e148e11ac2acaad"

data-is-external-id
OR
data-company-external-id

Use this to load a specific branch from your Branch Manager to the widget by using a pre-defined external id.
Note: Works only in combination with the attribute data-enterprise-id.

data-is-external-id="branch07"

data-enterprise-id

Use this to load the location finder as a first step of your widget. Works only if you have a TIMIFY Branch Manager account with more then 1 location.

Note: If you want to load the location finder you should not include the attribute data-account-id

data-enterprise-id="5c79487bed89503cfac758b3"

data-hide-close-button

Use this to hide the close button of the widget. This is a 'boolean'. The value can be only true or false.

data-hide-close-button="true"

OR

data-hide-close-button="false"

data-fullscreen

Use this to open the widget in full screen mode. This is a 'boolean'. The value can be only true or false.

data-fullscreen="true"

OR

data-fullscreen="false"

data-overlay-color

Use this to change the background colour of the overlay that covers your website when the widget is triggered (the background colour behind the widget).

Note: Always use HEX colour codes. If you don't know your HEX code, you can generate a one from here.

data-overlay-color="#F09368"

data-overlay-opacity

Use this to change the opacity of the background colour of the overlay.

data-overlay-opacity="0.2"

data-locale

Use this to pre-select a specific language for the booking widget.

Available language codes:
German: de-de
English: en-gb

French: fr-fr

Italian: it-it

Spanish: es-es
Catalan: ca-es

Dutch: nl-nl

Danish: da-dk
Norwegian: nn-no
Finnish: fi-fi
Swedish: sv-se

Bulgarian: bg-bg
Polish: pl-pl
Estonian: et-ee
Cymraeg (Scottish): cy-gb

data-locale="fr-fr"

data-position

Use this to allow multiple buttons to be positioned on the same page.

data-position="multiple"

data-custom-button-image

Use this to replace the standard TIMIFY button that appears on the right or left hand side of your website with an individual button graphic of your choice.

Note: The graphic needs to be uploaded on a FTP server and the URL should be added as a value to this attribute.

data-custom-button-image="https://www.yourwebsite.com/images/button.jpg"

data-button-attribute

Use this to allow the attribute data-account-id to be re-named. For example you can replace data-account-id=“your-TIMIFY-Company-ID" with timify-id="your-TIMIFY-Company-ID”

data-button-attribute="data-account-id"

data-show-company-name-in-header

Use this if you have multiple accounts/locations via the TIMIFY Branch Manager to display the name of the selected location from the Location Finder. This is a boolean.

data-show-company-name-in-header=“true”

1.2 Service related attributes

Attributes

Description

Example

data-show-services

Use this to only show a number of pre-defined services in the first step of the booking widget.
Make sure to use the ID of the respective service - you can find this on the service details page. You may use multiple service IDs - just make sure to separate them with commas.

data-show-services="5f6cbdb98e434611ef5bbf73"

OR

data-show-services="5f6cbdb98e434611ef5bbf73,5f6cc872471ac511d7e7afe4"

data-hide-services

Use this to hide some pre-defined services in the first step of the booking widget. Make sure to use the ID of the respective service - you can find this on the service details page. You may use multiple service IDs - just make sure to separate them with commas.

data-hide-services="5f6cbdb98e434611ef5bbf73"

OR

data-hide-services="5f6cbdb98e434611ef5bbf73,5f6cc872471ac511d7e7afe4"

data-service-id

Use this to pre-select a service of your choice and skip the first step of the widget by using the ID of the service in TIMIFY

data-service-id="5f6cbdb98e434611ef5bbf73"

data-service-external-ids

Use this to pre-select a service of your choice and skip the first step of the widget by using the external ID you've defined for it.

data-service-external-ids="service03"

data-course-id

Use this to pre-select a group service of your choice and skip the first step of the widget by using the ID of the group.

data-course-id="5f6d9ceeda9f6046487ed20b"

1.3 Resource related attributes

Attributes

Description

Example

data-resource-id

Use this to automatically pre-select a resource of your choice using its ID.
Note: If you use this in combination with the attribute data-service-id make sure the pre-selected resource is really assigned to that service.

data-resource-id="5f6ebc35533f6711c4c2e545"

data-resource-externalids

Use this to automatically pre-select a resource of your choice using the external ID you've defined for it.
Note: If you use this in combination with the attribute data-service-id make sure the pre-selected resource is really assigned to that service.

data-resource-externalids="room1"

data-filter-resources

Use this to filter the resources in the booking widget and only show the selected resources using their TIMIFY IDs.

data-filter-resources="5f72f486cfaace11d20d64bd,5f6cbe07d07c8611aae6b1dd"

data-filter-resources-by-external-id

Use this to filter the resources in the booking widget and only show the selected resources using the external ID you've defined for them.

data-filter-resources-by-external-id="room01,room03"

data-show-selected-resource-only

Use this to display only the pre-selected resource in the resource overview. This is a boolean.

Note: Works only in combination with data-resource-id and data-resource-externalids.

data-show-selected-resource-only="true"

data-show-resources

Use this to overwrite the Widget Setting that hides the resources by default. In order for this to work you should first go to Settings > Bookings > Booking Widget and from there activate the switch-box in the section Resource Display. This will lead to hiding by default your resources from all customers that see your widget. When you use this attribute you can overwrite this setting and display the resource select component in some cases to your customers.
This is a boolean.

data-show-resources="true"

1.4 Date related attributes

Attributes

Description

Example

data-date

Use this to automatically pre-fill and display the free slots on a specific date.
Note: The date format is YYYY-MM-DD

data-date="2021-05-17"

data-date-range

Use this to filter a pre-defined period for the date selection and display ONLY the available slots within this period.
Note: The date format is YYYY-MM-DD:YYYY-MM-DD.

data-date-range="2021-05-17:2021-05-23"

data-disable-other-dates

Use this to block the user from selecting any other date then the pre-filled one. This is a boolean.

data-disable-other-dates="true"

1.5 Customer related attributes

Attributes

Description

Example

data-show-guest-booking-form

Use this to display only the guest booking as the authentication method for your bookers. This is a boolean.

data-show-guest-booking-form="true"

data-skip-customerfields-section

Use this to skip showing the guest booking form and directly display the booking confirmation view.
Note: This works only if you have pre-filled all necessary data fields in the form using the params below. If any of the data-fields is not pre-filled (even if not mandatory) the booking the form will be displayed and the booker will be asked to fill-in the information.

data-skip-customerfields-section="true"

data-external-customer-id

Use this to pre-select an already existing customer in TIMIFY by providing it's external ID.

data-external-customer-id="CONT-19991882-CRM2"

data-guest-firstname

Use this to pre-fill the booker's first name automatically in the guest form.

data-guest-firstname="Max"

data-guest-lastname

Use this to pre-fill the booker's last name automatically in the guest form.

data-guest-lastname="Smith"

data-guest-email

Use this to pre-fill the booker's email automatically in the guest form.

data-guest-email="maxsmithdemotest@gmail.com"

data-guest-phone

Use this to pre-fill the booker's phone number automatically in the guest form.
Note: Do not include 0 or + or any empty spaces, just the number without country code. If you have a local / mobile operator code, e.g 0179 77 88 99 then the value should look like this 179778899

data-guest-phone="1786655322"

data-guest-phonecountry

Use this to pre-fill the booker's phone country code automatically in the guest form.

These are the currently allowed ISO 3166-1 Alpha-2-code values are:

‘fi’, ‘ae’, ‘ar’, ‘at’, ‘au’, ‘be’, ‘bn’, ‘br’, ‘bg’, ‘ca’, ‘us’, ‘ch’, ‘cn’, ‘cz’, ‘de’, ‘dk’, ‘eg’, ‘es’, ‘ee’, ‘fr’, ‘gb’, ‘gr’, ‘hk’, ‘hr’, ‘hu’, ‘id’, ‘ie’, ‘in’, ‘il’, ‘it’, ‘jp’, ‘kr’, ‘lu’, ‘mo’, ‘mt’, ‘mx’, ‘my’, ‘nl’, ‘no’, ‘ph’, ‘pl’, ‘pt’, ‘ro’, ‘ru’, ‘sa’, ‘sg’, ‘sk’, ‘se’, ‘th’, ‘tr’, ‘tw’, ‘co’, ‘cl’

More on ISO 3166-1 country code values can be found here.

data-guest-phonecountry="de"

data-customer-field-1
data-customer-field-2
data-customer-field-N

Use this to pre-fill any custom data field that you've enabled in the booking form.

The format is data-customer-field-1="<ID>-<VALUE>" where <ID> is the id of your data field in TIMIFY and the <VALUE> is the pre-filled value for that field. Let's say you have a field VIP Member ID and you want to pre-fill it. In this case the code will look like:

data-customer-field-1="5f6cbe62587de011ff6c68f7-MemberID9998881"

If you have multiple custom data fields that you want to pre-fill it is important to give each of them a unique attribute name. So in the above example if now I want to pre-fill another field, where I ask my booker what food they prefer, since we already use the attribute name data-customer-field-1 we will have to simply replace the number at the end to data-customer-field-2.

If you use as a data field type a checkbox the value should be replaced simply with true.

data-customer-field-1="5f6cbe62587de011ff6c68f7-MemberID9998881"

data-customer-field-2="5f6cbd052e148e11ac2acac1-vegetarian"

data-customer-field-3="5f6cbd052e148e11ac2acab9-true"

1.6 Customisation related attributes

Attributes

Description

Example

data-customization-id

Use this to overwrite the default company or enterprise widget customisation. For example you can trigger a special widget customisation when a specific service or a resource is pre-filled.

data-customization-id="5dd6a2fcfefe8710f1d45ba6"

data-template-customization-id

Use this to overwrite the default company or enterprise email template customisation. For example you can trigger a special email template customisation when a specific service is pre-filled or you are triggering the widget from a different medium - let's say you have one customised widget for your website and a different one for your mobile app.

data-template-customization-id="5de4f70480e1ae10f731a56c"

1.7 Trigger the rescheduling for a specific booking

If you're using the TIMIFY REST API and let's say you want to display all booked appointments that will take place in the future in the customer's section of your app or website so your customers can easily reschedule a particular booking from there. You can trigger a rescheduling process for a specific booking by providing both the data-event-id and data-secret of the booking. Usually you would obtain these if you have subscribed to receive a webhook with the scope EVENT-CREATED. The secret for cancellation or rescheduling can be obtained only via webhook and can be found in the metadata.

Attributes

Description

Example

data-event-id

This is the id of the booking in TIMIFY.

data-event-id="5f748b0296782111e4eed9e9"

data-secret

This is the secret for the booking in TIMIFY.

data-secret="5e1c4da96456f911e04bc18c-xx991882owks00921ms0923109381872m8dn3872nmds983kksiahdhd"

1.8 Display hidden booking slots from a pre-reservation

In TIMIFY, currently available only via the Booking Links App, you are able to pre-reserve a specific slot or a range of slots within a date range and make those available only to customers who have a special access to your widget that reveals them by parsing a secret key of that pre-reservation. Using the data-pre-reservation-key you can parse this secret to the widget and reveal the otherwise hidden slots. Let's say you want to make Thursday the 25th of October 2021 between 15:00 and 17:00 available ONLY to some selected customers of yours. You can create a pre-reservation for that day and time range and you will block it for all your regular customers. Then by parsing the secret key of the pre-reservation in your booking widget you can make this date and time slots visible only to those selected few customers.

Attributes

Description

Example

data-pre-reservation-key

The secret key for the pre-reservation.

data-pre-reservation-key="882owks00921ms0923109381872m8dn3872nmds983kksi"

1.9 Tracking marketing campaign conversions (COMING SOON)

If you want to track from which source, medium or campaign a booking is coming, you can do that by parsing your UTM parameters to the booking widget. The data will be then displayed in the Booking Statistics of your account or if you use our Branch Manager tool in the Statistics Dashboard. Here is a list with the currently supported attributes:

Attributes

Description

Example

data-meta-<utmContent>

Use this attribute to parse and save the UTM Content with the booking. This is usually an optional field. If you have multiple links in the same campaign, like two links in the same email, you can fill in this value so you can differentiate between them.

data-meta-<utmContent>="HeaderLink"

data-meta-<utmSource>

Use this attribute to parse and save the UTM Source with the booking. This is usually a required parameter and is used to identify which site sent the traffic and made the conversion.

data-meta-<utmSource>="Google"

data-meta-<utmMedium>

Use this attribute to parse and save the UTM Medium with the booking. This is usually used to identify what type of link was used, such as cost per click or email.

data-meta-<utmMedium>="cpc"

data-meta-<utmCampaign>

Use this attribute to parse and save the UTM Campagin with the booking. This is usually used to identify a specific product promotion or strategic campaign.

data-meta-<utmCampaign>="spring_promotion"

data-meta-<utmTerm>

Use this attribute to parse and save the UTM Search Term with the booking. This is usually used to identify the search term in Google Ads.

data-meta-<utmTerm>="contact lenses+consultation"

-----------------------------------------------------------------------------------------------------------------------------

2. Customisation options for a booking widget iFrame

To see a live example of how a user has customised their iFrame widget, click here

The code snippet for the iFrame should look something like this:

<iframe src="https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&hideCloseButton=true" style="border:0px #ffffff none;" name="myTimifyWidget" scrolling="no" frameborder="0" marginheight="0px" marginwidth="0px" height="800px" width="700px" allowfullscreen></iframe>

Copy and paste this code into the HTML of the page where you want the widget to appear on your page. Don't forget to adjust the URL in the "src" attribute according to your account by using the individual accountId for your TIMIFY account. You can also change the height and width of the iFrame by changing the values of the parameters ("height" or "width") in the code above.

With the following parameters you can make further customisations in your widget and adapt the booking process perfectly to your requirements.

A parameter is always appended with a "&" to the existing widget URL. Let's say you would like to hide the close button of the widget when a customer of yours opens the widget link. In this case you need to add the parameter &hideCloseButton=true. This is how your link would look like:

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&hideCloseButton=true

2.1 General and layout related parameters

Parameters

Description

Example

accountId

Use this to load your account or a specific branch to the widget.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad

companyExternalId

OR

iscompanyExternalId (deprecated)

Use this to load a specific branch from your Branch Manager account to the widget by using a pre-defined external id.
Note: It should be always in combination with the parameter 'enterpriseId'.

https://book.timify.com/services?enterpriseId=5c79487bed89503cfac758b3&companyExternalId=branch07

enterpriseId

Use this to load the location finder as a first step of your widget. Works only if you have a TIMIFY Branch Manager account with more then 1 location.

Note: If you want to load the location finder you should not include the attribute data-account-id.

https://book.timify.com/locations?enterpriseId=5c79487bed89503cfac758b3

hideCloseButton

Use this to hide the close button of the widget. This is a 'boolean'. The value can be only true or false.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&hideCloseButton=true

fullscreen

Use this to open the widget in full screen mode. This is a 'boolean'. The value can be only true or false.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&fullscreen=true

overlayColor

Use this to change the background colour behind the widget.

Note: Always use HEX colour codes. If you don't know your HEX code, you can generate a one from here.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&overlayColor=#F09368

overlayOpacity

Use this to change the opacity of the background colour behind the widget.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&overlayColor=#F09368&overlayOpacity=0.2

locale

Use this to pre-select a specific language for the booking widget.

Available language codes:
German: de-de
English: en-gb

French: fr-fr

Italian: it-it

Spanish: es-es
Catalan: ca-es

Dutch: nl-nl

Danish: da-dk
Norwegian: nn-no
Finnish: fi-fi
Swedish: sv-se

Bulgarian: bg-bg
Polish: pl-pl
Estonian: et-ee
Cymraeg (Scottish): cy-gb

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&locale=da-dk

showCompanyNameInHeader

Use this if you have multiple accounts/locations via the TIMIFY Branch Manager to display the name of the selected location from the Location Finder. This is a boolean.

https://book.timify.com/locations?enterpriseId=5c79487bed89503cfac758b3&showCompanyNameInHeader=true

2.2 Service related parameters

Parameters

Description

Example

showServices

Use this to only show a number of pre-defined services in the first step of the booking widget.
Make sure to use the ID of the respective service - you can find this on the service details page. You may use multiple service IDs - just make sure to separate them with commas.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&showServices=5f6cbdb98e434611ef5bbf73

OR

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&showServices=5f6cbdb98e434611ef5bbf73,5f6cc872471ac511d7e7afe4

hideServices

Use this to hide some pre-defined services in the first step of the booking widget. Make sure to use the ID of the respective service - you can find this on the service details page. You may use multiple service IDs - just make sure to separate them with commas.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&hideServices=5f6d9ceeda9f6046487ed20b

OR

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&hideServices=5f6d9ceeda9f6046487ed20b,5f6cbdb98e434611ef5bbf73

serviceId

Use this to pre-select a service of your choice and skip the first step of the widget.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&serviceId=5f6cbdb98e434611ef5bbf73

serviceExternalIds

Use this to pre-select a service of your choice and skip the first step of the widget by using the external ID you've defined for it.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&serviceExternalIds=service03

courseId

Use this to pre-select a group service of your choice and skip the first step of the widget by using the ID of the group.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&courseId=5f6d9ceeda9f6046487ed20b

2.3 Resource related parameters

Parameters

Description

Example

resourceId

Use this to automatically pre-select a resource of your choice.
Note: If you use this in combination with the attribute data-service-id make sure the pre-selected resource is really assigned to that service.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&resourceId=5f6ebc35533f6711c4c2e545

resourceExternalIds

Use this to automatically pre-select a resource of your choice using the external ID you've defined for it.
Note: If you use this in combination with the attribute data-service-id make sure the pre-selected resource is really assigned to that service.

https://book.timify.com/conflict?accountId=5f6cbd042e148e11ac2acaad&resourceExternalIds=room02

filterResources

Use this to filter the resources in the booking widget and only show the selected resources using their TIMIFY IDs.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&filterResources=5f72f486cfaace11d20d64bd,5f6cbe07d07c8611aae6b1dd

filterResourcesbyExternalId

Use this to filter the resources in the booking widget and only show the selected resources using the external ID you've defined for them.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&filterResourcesbyExternalId=room01,room03

showSelectedResourcesOnly

Use this to display only the pre-selected resource in the resource overview. This is a boolean.

Note: Works only in combination with data-resource-id and data-resource-externalids.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&showSelectedResourcesOnly=true&resourceId=5f6ebc35533f6711c4c2e545

showResources

Use this to overwrite the Widget Setting that hides the resources by default. In order for this to work you should first go to Settings > Bookings > Booking Widget and from there activate the switch-box in the section Resource Display. This will lead to hiding by default your resources from all customers that see your widget. When you use this attribute you can overwrite this setting and display the resource select component in some cases to your customers.
This is a boolean.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&showResources=true

2.4 Date related parameters

Parameters

Description

Example

date

Use this to automatically pre-fill and display the free slots on a specific date.
Note: The date format is YYYY-MM-DD

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&date=2021-08-17

dateRange

Use this to filter a pre-defined period for the date selection and display ONLY the available slots within this period.
Note: The date format is YYYY-MM-DD:YYYY-MM-DD.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&dateRange=2021-08-05:2021-08-09

disableOtherDates

Use this to block the user from selecting any other date then the pre-filled one. This is a boolean.

https://book.timify.com/auth?accountId=5f6cbd042e148e11ac2acaad&date=2021-08-17&disableOtherDates=true

2.5 Customer related parameters

Parameters

Description

Example

showGuestBookingForm

Use this to display only the guest booking as the authentication method for your bookers. This is a boolean.

https://book.timify.com/customer-fields?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true

skipCustomerFieldsSection

Use this to skip showing the guest booking form and directly display the booking confirmation view.
Note: This works only if you have pre-filled all necessary data fields in the form using the params below and you use the parameter showGuestBookingForm. If any of the data-fields is not pre-filled (even if not mandatory) the booking the form will be displayed and the booker will be asked to fill-in the information.

https://book.timify.com/confirm?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true&guestFirstName=Max&guestLastName=Smith&guestEmail=maxsmithdemo@gmail.com&guestPhone=1765544321&guestPhoneCountry=de&customerField[5f6cbe62587de011ff6c68f7]=MemberID999888777&skipCustomerFieldsSection=true

externalCustomerId

Use this to pre-select an already existing customer in TIMIFY by providing it's external ID.

https://book.timify.com/success?accountId=5f6cbd042e148e11ac2acaad&externalCustomerId=customer-123

guestFirstName

Use this to pre-fill the booker's first name automatically in the guest form.

https://book.timify.com/confirm?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true&guestFirstName=Max

guestLastName

Use this to pre-fill the booker's last name automatically in the guest form.

https://book.timify.com/confirm?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true&guestLastName=Smith

guestEmail

Use this to pre-fill the booker's email automatically in the guest form.

https://book.timify.com/confirm?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true&guestEmail=maxsmithdemo@gmail.com

guestPhone

Use this to pre-fill the booker's phone number automatically in the guest form.
Note: Do not include 0 or + or any empty spaces, just the number without country code. If you have a local / mobile operator code, e.g 0179 77 88 99 then the value should look like this 179778899

https://book.timify.com/confirm?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true&guestPhone=1765544321&guestPhoneCountry=de

guestPhoneCountry

Use this to pre-fill the booker's phone country code automatically in the guest form.

These are the currently allowed ISO 3166-1 Alpha-2-code values are:

‘fi’, ‘ae’, ‘ar’, ‘at’, ‘au’, ‘be’, ‘bn’, ‘br’, ‘bg’, ‘ca’, ‘us’, ‘ch’, ‘cn’, ‘cz’, ‘de’, ‘dk’, ‘eg’, ‘es’, ‘ee’, ‘fr’, ‘gb’, ‘gr’, ‘hk’, ‘hr’, ‘hu’, ‘id’, ‘ie’, ‘in’, ‘il’, ‘it’, ‘jp’, ‘kr’, ‘lu’, ‘mo’, ‘mt’, ‘mx’, ‘my’, ‘nl’, ‘no’, ‘ph’, ‘pl’, ‘pt’, ‘ro’, ‘ru’, ‘sa’, ‘sg’, ‘sk’, ‘se’, ‘th’, ‘tr’, ‘tw’, ‘co’, ‘cl’

More on ISO 3166-1 country code values can be found here.

https://book.timify.com/confirm?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true&guestPhone=1765544321&guestPhoneCountry=de

customerField[ID]

Use this to pre-fill any custom data field that you've enabled in the booking form.

The format is customerField[ID]=VALUE where <ID> is the id of your data field in TIMIFY and the VALUE is the pre-filled value for that field. Let's say you have a field VIP Member ID and you want to pre-fill it. In this case the code will look like:

customerField[5f6cbe62587de011ff6c68f7]=MemberID999888777

If you use as a data field type a checkbox the value should be replaced simply with true.

https://book.timify.com/confirm?accountId=5f6cbd042e148e11ac2acaad&showGuestBookingForm=true&customerField[5f6cbe62587de011ff6c68f7]=MemberID999888777&skipCustomerFieldsSection=true

2.6 Customisations related parameters

Parameters

Description

Example

customisationId

Use this to overwrite the default company or enterprise widget customisation. For example you can trigger a special widget customisation when a specific service or a resource is pre-filled.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&customisationId=5dd3b016a5c46410e5568fac

templatesCustomisationId

Use this to overwrite the default company or enterprise email template customisation. For example you can trigger a special email template customisation when a specific service is pre-filled or you are triggering the widget from a different medium - let's say you have one customised widget for your website and a different one for your mobile app.

https://book.timify.com/success?accountId=5f6cbd042e148e11ac2acaad&templatesCustomisationId=5de4f70480e1ae10f731a56c

2.7 Trigger the rescheduling for a specific booking

If you're using the TIMIFY REST API and let's say you want to display all booked appointments that will take place in the future in the customer's section of your app or website so your customers can easily reschedule a particular booking from there. You can trigger a rescheduling process for a specific booking by providing both the eventId and secret of the booking. Usually you would obtain these if you have subscribed to receive a webhook with the scope EVENT-CREATED. The secret for cancellation or rescheduling can be obtained only via webhook and can be found in the metadata.

Parameters

Description

Example

eventId

This is the id of the booking in TIMIFY. This parameter works only in combination with secret.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&eventId=5f75e3295b3aa811f85822e9&secret=3fcd6975-3620-4874-a314-e07d7dd4dd71

secret

This is the secret for the booking in TIMIFY. This parameter works only in combination with eventId.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&eventId=5f75e3295b3aa811f85822e9&secret=3fcd6975-3620-4874-a314-e07d7dd4dd71

2.8 Display hidden booking slots from a pre-reservation

In TIMIFY, currently available only via the Booking Links App, you are able to pre-reserve a specific slot or a range of slots within a date range and make those available only to customers who have a special access to your widget that reveals them by parsing a secret key of that pre-reservation. Using the preReservationKey you can parse this secret to the widget and reveal the otherwise hidden slots. Let's say you want to make Thursday the 25th of October 2021 between 15:00 and 17:00 available ONLY to some selected customers of yours. You can create a pre-reservation for that day and time range and you will block it for all your regular customers. Then by parsing the secret key of the pre-reservation in your booking widget you can make this date and time slots visible only to those selected few customers.

2.9 Tracking marketing campaign conversions (COMING SOON)

If you want to track from which source, medium or campaign a booking is coming, you can do that by parsing your UTM parameters to the booking widget. The data will be then displayed in the Booking Statistics of your account or if you use our Branch Manager tool in the Statistics Dashboard. Here is a list with the currently supported attributes:

Parameters

Description

Example

meta[utmContent]

Use this attribute to parse and save the UTM Content with the booking. This is usually an optional field. If you have multiple links in the same campaign, like two links in the same email, you can fill in this value so you can differentiate between them.

https://book.timify.com/availability?accountId=5f6cbd042e148e11ac2acaad&meta[utmContent]=HeaderLink

meta[utmSource]

Use this attribute to parse and save the UTM Source with the booking. This is usually a required parameter and is used to identify which site sent the traffic and made the conversion.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&meta[utmSource]=Google

meta[utmMedium]

Use this attribute to parse and save the UTM Medium with the booking. This is usually used to identify what type of link was used, such as cost per click or email.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&meta[utmMedium]=cpc

meta[utmCampaign]

Use this attribute to parse and save the UTM Campagin with the booking. This is usually used to identify a specific product promotion or strategic campaign.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&meta[utmCampaign]=spring-promotion

meta[utmTerm]

Use this attribute to parse and save the UTM Search Term with the booking. This is usually used to identify the search term in Google Ads.

https://book.timify.com/services?accountId=5f6cbd042e148e11ac2acaad&meta[utmTerm]=contactlenses+consultation

-----------------------------------------------------------------------------------------------------------------------------

3. Customisation options using our REST API 

If you want to have an online booking experience that takes on board your corporate branding and specific booking workflows, this is for you. We go deep into your existing IT infrastructure, break down our widget, and re-build it so that it becomes a seamless extension of your API and interface. We take into account the needs and preferences or your clients, so that online booking becomes an integral part of your omni-channel experience.

This option involves accessing our developer platform, and a little bit of training with a dedicated technical specialist. To find out more, please contact our customer support via the chat bubble in the bottom right corner of your browser when you authenticate with your TIMIFY account.

Did this answer your question?