Toggle menu

Email and Message Template Configuration

The templates used in the emails and other messages generated by Bookings is set using the "Communications Template Manager". Various tokens can also be added to your templates which will be substituted with the correct values before the emails are sent or message displayed.

Email Templates

Booking Complete

This optional email is sent when the event "completes". The default behaviour is for Bookings to tidy up and complete events four hours after their scheduled end time (this grace period can be changed in the Bookings configuration end point using the finishInstanceGracePeriod setting).

The email is sent to everyone who booked onto the event, and the template you'd like to use is picked when the event is scheduled.

Booking Confirmation

The booking confirmation email is sent to the person booking the event once they have paid for their packages. If the event is free the email is sent as soon as the package is booked. The variations of this template will appear in the drop-down of the form used to schedule occurrences.

QR Code

To include a QR code in the confirmation email, add the {{qrCodeImg}} token. Note that currently the only information that can be encoded is the business key of the booking.

For example:

<img src="{{qrCodeImg}}" width="150" height="150" alt="{{_businessKey}}"/>

Tokens

TokenDescription
isAssistedWill be true if Bookings is being used via Assisted Service, allowing a different message to be displayed
form_WORKFLOWThe business key (booking reference)
fixedPriceThe total paid
packagesSoldPackage information held in an array. You can add details of all packages purchased by the user using:

{{#each packagesSold}}
    <p><strong>{{name}}</strong> (x{{quantity}})</p>
{{/each}}
qrCodeImgA QR code including the business key of the booking, see above
form_EMAILThe booker's email address
form_EVENTNAMEThe name of the event (the article heading)
form_LOCATIONThe location of the event (the article heading)
form_LOCALEBOOKABLEIDThe event article ID
form_LOCALELOCATIONIDThe location article ID
form_NAMEThe name of the booker
form_NOTESNotes added by the booker
form_PAYIDPayment transaction ID (could be blank for offline payments or match the workflow business key for some providers)
form_PAYINGBYCASHIf offline payment was taken
form_PRETTYDATEThe event date and time
form_QUANTITYNumber of tickets bought
form_SHOWDATESReturns true/false if dates were/weren't shown on the form
form_TELThe bookers phone number

Booking Moved

Confirmation sent to the booker when their booking is moved by an admin user using the Move, Update or Cancel Bookings form.

Tokens

TokenDescription
BOOKINGBKThe business key (booking reference)
form_EMAILThe booker's email address
form_NAMEThe booker's name
form_EVENTNAMEThe name of the new event (article heading)
form_LOCATIONThe name of the new location (article heading)
form_LOCALELOCATIONIDThe new location article ID
form_PRETTYDATEThe date and time of the new event
form_OLDEVENTNAMEThe name of the old event (article heading)
form_OLDPRETTYDATEThe date and time of the old event
form_SHOWDATESReturns true/false if dates were/weren't shown on the form
packagesSoldPackage information

Booking Reminder

A reminder email sent out prior to the event. Reminder emails are configured when Creating and Scheduling Event Occurrences.

Cancel Booking Message

Not an email but the text displayed on screen when an admin user cancels a booking.

Cancelled Event

This email is sent to all users who have booked onto an event if it gets cancelled. The administrator cancelling the event has the option to send this email or write one of their own. This template only uses a single default variation.

Tokens

TokenDescription
EVENTNAMEThe name of the event
form_BOOKABLEIDThe ID of the event article
PRETTYDATERANGEThe date and time of the event
form_ENDDATETIMEThe end time in ISO format
form_STARTDATETIMEThe start time in ISO format
form_LOCATIONThe name of the location
form_LOCATIONIDThe ID of the location article

Notify X Places Left

This email is sent to the email address entered when an event occurrence is created. It will be triggered once the number of places remaining reaches the number defined. This template only uses a single default variation.

Notify Each Booking

This email is sent to the email address entered when an event occurrence is created. It is triggered after each booking is made. This template only uses a single default variation.

Notify Notes

The email sent to the "notify notes" email address when a booker adds additional notes at the payment stage of their booking.

Successful Payment Message

The message is displayed once payment has been made. The variations of this template will appear in the drop-down of the form used to schedule occurrences.

Updated Event

Not an email but the text displayed on screen when an admin user updates an event.

Last modified on 5 September 2023

Share this page

Facebook icon Twitter icon email icon

Print

print icon