Difference between revisions of "Auto Actions"

From Beds24 Wiki
Jump to navigation Jump to search
 
(258 intermediate revisions by 5 users not shown)
Line 12: Line 12:
 
__TOC__
 
__TOC__
  
== General Information and Setup ==
+
==Summary==
 +
<div class="summarybox">
 +
An Auto Action is an action which can be used '''manually or programmed to run automatically''' at a specific time relative to the time of the '''booking''', to the '''check-in''' date or to the '''check-out''' date.
  
An Auto Action is an action which can be programmed to run at a specific time relative to the time of the booking, to the check in date or to the check out date.  
+
Auto actions have one or more trigger conditions and one or more actions. They can be triggered on a number of different conditions, like property, time or booking related conditions. Auto Actions can
 +
*send pre-drafted Emails, messages or SMS
 +
*change booking information
 +
*change invoice information
 +
*run webhooks
 +
*trigger HTTP POST notifications
 +
You can create chains of actions to automate workflows.
 +
</div>
 +
 
 +
== General Information ==
 +
Template variables provide great flexibility when creating/managing the Auto Actions. Setup one Auto Action to trigger on multiple/all properties/rooms with the property specific details, using the [[Template Variables]]. This removes the need to duplicate your auto actions for each Property. Reducing the ongoing management, multiple copies of the same auto action will require you to edit/modify each auto action rather than update one auto action.
 +
 
 +
Using 'Group Keywords' you can refine the triggers in the Auto Action to include/exclude properties if the purpose/message in the Auto action needs to be different.
 +
 
 +
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span>  Auto Actions are  not designed as real-time actions. They are sent in batches at times so we recommend you set your triggers to allow for this.
 +
 
 +
== Setup ==
 +
Go to {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTION
 +
 
 +
*Click 'Add New Action' button. You can choose whether you want to start with an empty Auto Action or whether you want to use a template that you can customise further.
 +
 
 +
*To MODIFY an Auto Action, scroll to the Auto Action and click on "Edit", make the changes and click SAVE.
  
Auto actions have one or more trigger conditions and one or more actions. They can be triggered on a number of different conditions, like property, time or booking related conditions. Actions can be to send pre-drafted emails or SMS, change booking or invoice information or run webhooks.
+
*To create a COPY of an Auto Action, click "Edit" on an existing auto action, scroll to the bottom of the page and click 'Save as copy'.  
  
Go to SETTINGS > GUEST MANAGEMENT > AUTO ACTION and click on "Edit" to modify an existing auto action or on "Create New Action" to set up a new auto action.
+
*To DELETE an Auto Action, click "Edit" on an existing auto action, scroll to the bottom of the page and click 'Delete'.  
  
'''You can choose to send an auto action automatically or manually:'''
+
'''Trigger Action : '''  
  
'''Auto sending:'''
+
You can choose to trigger an auto action automatically or manually.
  
Auto Action Emails which are sent automatically by the system are sent from the EMail address of the account that created the Auto Action. This is the account set up in in SETTINGS-ACCOUNT-OUTGOING EMAIL. Automatic actions will trigger every 15 minutes.
+
*'''Manual:''' If set to manual actions can be triggered manually from the MAIL/ACTION tab of each booking.
 +
 
 +
*'''Auto:''' Auto action will automatically trigger on a booking based on the rules set in the Trigger tab. Check the details in the MAIL/ACTION tab of each booking. You will see if the auto action has triggered and when, if it has not triggered then you can check if it is due to trigger and when.
 +
 
 +
===Setup Outgoing Email Service - Required for sending Emails via Auto Actions===
 +
Go to {{#fas:cog}} (SETTINGS) ACCOUNT -> OUTGOING EMAIL and follow the instructions to connect your email address/account to Beds24.
 +
 
 +
'''Auto sending:'''
 +
 
 +
The auto action batch process runs multiple times per hour.
 +
 
 +
Auto Action Emails which are sent automatically by the system are sent from the EMail address of the account that created the Auto Action. This is the account set up in in {{#fas:cog}} (SETTINGS) ACCOUNT-> OUTGOING EMAIL.
  
 
'''Manual sending:'''  
 
'''Manual sending:'''  
  
When sending manually by clicking on the 'Send now' button you will need to make sure you are logged into the account which uses the Email address you want to send from.
+
When sending manually by clicking on the 'Send now' button the Email address of the user you are logged in as will be be used.  
  
'''Before setting up an auto action please note:'''
+
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>To use this function you need to set the system to use your own Email address for outgoing emails under {{#fas:cog}} (SETTINGS) ACCOUNT -> OUTGOING EMAIL.
  
<span style="color:#fe746c;>{{#fas:exclamation-triangle}} </span>To use this function you need to set the system to use your own Email address for outgoing emails under SETTINGS -> ACCOUNT -> OUTGOING EMAIL.  
+
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> Confirmation emails will send automatically to the guest. You can customize them in {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT -> CONFIRMATION MESSAGES.
  
<span style="color: #f3e504; font-size: 200%;" >{{#fas:lightbulb}} </span> Confirmation messages will send automatically to the guest. You can customize them in SETTINGS -> GUEST MANAGEMENT -> CONFIRMATION MESSAGES.
+
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> The auto actions will appear on the 'Mail & Actions' tab of each booking where you manually trigger the email/messages/changes to the booking.  
  
<span style="color: #f3e504; font-size: 200%;" >{{#fas:lightbulb}} </span> The auto actions will appear on the 'Mail & Actions' tab of each booking where you manually can send the email trigger the changes to the booking. If you are using your own mail server for outgoing mail the Booking and Invoice actions will also be applied before sending the mail.
+
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you are using your own mail server for outgoing email/messages the Booking and Invoice actions will be applied before sending the mail.
  
 
===Auto Actions and Subaccounts===
 
===Auto Actions and Subaccounts===
 
Auto Actions are account functions, i.e. they apply per account.  
 
Auto Actions are account functions, i.e. they apply per account.  
  
1. Account A (master account or subaccount) in which the auto action was created.  
+
'''1. Account A''' (master account or subaccount) in which the auto action was created.  
  
 
Auto Actions are available according to the "Property" setting in the "Trigger" tab. I.e. either for
 
Auto Actions are available according to the "Property" setting in the "Trigger" tab. I.e. either for
Line 48: Line 82:
 
*all properties visible in the account (properties belonging to the account, properties available in the account).
 
*all properties visible in the account (properties belonging to the account, properties available in the account).
  
2. Another account B (master account or sub-account) in which the Auto Action has not been created.
+
'''2. Another account B''' (master account or sub-account) in which the Auto Action has not been created.
  
 
Auto Actions are only available for properties that belong to Account A and have been made available in Account B.  
 
Auto Actions are only available for properties that belong to Account A and have been made available in Account B.  
Line 59: Line 93:
 
Sets the criteria which have to be fulfilled to start the Auto Action.  
 
Sets the criteria which have to be fulfilled to start the Auto Action.  
  
"Booking Source" = "Direct" applies the Auto Actions only to bookings from your own web site, manually added bookings and bookings imported though the API (not the channel manager). If you want to apply and Auto Action only to manually added bookings add your username in the "Referrer" field.
+
'''Property, Room, Unit'''
 +
 
 +
You can refine the use of the Auto Action, by specifying if it should trigger on specific properties or all properties/rooms.
 +
 
 +
You can select if it should trigger on All properties, All Owned by, All visible in account or a specific Property. If you select a specific Property then you can also select a specific Room id.
 +
 
 +
It is possible to 'Exclude' specific Beds24 Room ids, you can find the Room id from the Room Setup.  
 +
 
 +
If required, you can also specify specific Offers/Units in Room Types.
 +
 
 +
Send/Exclude Property Groups, this will use the values you have entered in {{#fas:cog}} (SETTINGS) BOOKING PAGE > MULTIPLE PROPERTIES > PROPERTY SETTINGS > GROUP KEYWORDS.  
 +
 
 +
'''Time'''
  
"Trigger Time" defines when the action is allowed to start.  Once it has started it is allowed to go for the "Time Window" period.  When the "Time Window" period has elapsed the auto action stops.  
+
"Trigger Time" and "Trigger Event" define when the action is allowed to start.  Once it has started it is allowed to go for the "Time Window" period.  When the "Time Window" period has elapsed the auto action stops.
  
 
Both "Trigger Time" and "Time Window" are relative to a "Trigger Event"  i.e. check-in, check-out, time of booking.
 
Both "Trigger Time" and "Time Window" are relative to a "Trigger Event"  i.e. check-in, check-out, time of booking.
 +
 +
"Between Booking and Check in" can be used to include/exclude Same day/Near term bookings, set the number of days.
 +
 +
"Check In From" and "Check In To" use if you have specific information relating to bookings between these dates, special offers, major disruptions etc.
 +
 +
'''Booking Source'''
 +
 +
"Booking Source" = "Direct" applies the Auto Actions only to bookings from your own web site, manually added bookings and bookings imported though the API (not the channel manager). If you want to trigger only on manually added bookings add your username in the "Referrer" field. 
 +
 +
'''Booking Conditions'''
 +
 +
"Group Booking Trigger" - use the (?) context help for the options.
 +
"Invoice Balance" - use this to for payments and reminders.
 +
 +
'''Info Codes'''
 +
 +
If you use Booking Info Codes in your bookings, you can enter values to include/exclude bookings.
 +
 +
'''Booking Fields'''
 +
 +
Select the appropriate fields from the drop down lists. You can also use an AND/OR option.
 +
 +
"Template variables" can be used in the fields to generate dynamic values based on the booking. See the options in this section [[Template_Variables#Smart_Logic_Template_Variables|Smart Template Variables]]
  
 
== Actions ==
 
== Actions ==
  
 
=== Messaging/Email ===
 
=== Messaging/Email ===
Go to Email to create or modify a prepared Email template. Templates can contain [[Template Variables]]  to include information specific to the booking in the Email, for example the guests name or the arrival date.
+
Go to "Messaging" to create or modify a prepared Email/Message template. Templates can contain [[Template Variables]]  to include information specific to the booking in the Email/Message, for example the guests name or the arrival date.
  
*To send Emails automatically you need to set up your outgoing Email address in SETTINGS -> ACCOUNT -> OUTGOING EMAIL.  
+
*To send messages via the Message API, then enter the text in the PLAIN text box, for emails, enter the text in the HTLM Box.  
  
*To send Emails manually open a booking and go to the MAIL tab. Manual Emails will open in a window, you may send it as is or edit it before sending.
+
*To send Emails automatically you need to set up your outgoing Email address in {{#fas:cog}} (SETTINGS) ACCOUNT -> OUTGOING EMAIL.
 +
 
 +
*To send Emails manually open a booking and go to the MAIL/Action tab. Manual Emails will open in a window, you may send it as is or edit it before sending.
  
 
Some systems have a limit of about 2000 characters for this form of email generation. If the email will not open try reducing the amount of text.
 
Some systems have a limit of about 2000 characters for this form of email generation. If the email will not open try reducing the amount of text.
  
If Auto Action Emails are send automatically they are send through your Email server. You should see this on your server. Whether you see it in your Sent box or not depends on your Email program.
+
If Auto Action Emails are sent automatically they will send through your Email server. You should see this on your server. Whether you see it in your Sent box or not depends on your Email program.
  
 
If Auto Action Emails are sent manually via a link in the "Email Templates" list in the booking Beds24 will first try to send through your Email server. You should see this on your server. Whether you see it in your Sent box or not depends on your Email program.
 
If Auto Action Emails are sent manually via a link in the "Email Templates" list in the booking Beds24 will first try to send through your Email server. You should see this on your server. Whether you see it in your Sent box or not depends on your Email program.
Line 88: Line 159:
  
 
Other files can not be attached. We recommend you use a link to a file you upload to your web site.
 
Other files can not be attached. We recommend you use a link to a file you upload to your web site.
 +
 +
===HTML and Templates===
 +
If you use HTML you will need to make sure your code is correct and clean otherwise it might trigger our firewall.
 +
 +
HTML messages created by third party services is often convoluted and might contain critical content. Some tools like https://stripo.email/ or https://www.designedwithbee.com/ that allow you to create your own templates and also provide many  templates have tested to work well in Beds24.
  
 
=== SMS ===
 
=== SMS ===
 
You can automatically send SMS messages. Please note that a fee per SMS message applies if this function is activated.
 
You can automatically send SMS messages. Please note that a fee per SMS message applies if this function is activated.
  
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> The SMS will send in the language of the account, not the language of the booking. Read Example 17 for a way to control the language of the SMS.
+
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span> SMS can only be used to communicate Information about a current booking. For legal reasons you can not use SMS for marketing purposes including discounts or vouchers.
 +
 
 +
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> The SMS will send in the language of the account, not the language of the booking. Read Example "Send an Email in the guests language to an internal Email address" for a way to control the language of the SMS.
  
 
=== Booking ===
 
=== Booking ===
 
Go to the tab 'Booking' to set up an auto action which modifies something in the booking.
 
Go to the tab 'Booking' to set up an auto action which modifies something in the booking.
 +
 +
"Execution" - default is 'One time only' or 'Allow Repeats' This action can run one time only or repeat within the trigger time period.
 +
 +
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> Emails are always triggered once only regardless of this setting.
  
 
=== Booking Info ===
 
=== Booking Info ===
Set up auto actions which automatically add or remove info codes.  
+
Set up auto actions which automatically add or remove info codes. This is good practice for reporting and also to trigger/exclude bookings from other auto actions.
 +
 
 +
Booking info codes can be used to 'sequence' your auto actions.
 +
 
 +
For example, you have an auto action that sends a message to the guest, but only after another action has already triggered.
 +
 
 +
Consider the auto action to add a pending payment to a booking for the Security deposit authorisation, this should only be triggered when the Booking info code = STRIPEPAYEMNT or CARDTOSTRIPE, both confirm the guest credit card is in the booking.
  
 
=== Invoice ===
 
=== Invoice ===
Automatically add invoice items or pending payments.
+
 
 +
Automatically Assign Invoice Number.
 +
 +
Automatically add/update invoice items or pending payments.
 +
 
 +
Pending payments can use Payment Rules defined in {{#fas:cog}} (SETTINGS)->PAYMENTS->PAYMENT RULES.
  
 
Invoice changes are applied before the mail is sent.
 
Invoice changes are applied before the mail is sent.
Line 111: Line 204:
 
Create auto actions which trigger a web hook when the trigger conditions are met.
 
Create auto actions which trigger a web hook when the trigger conditions are met.
  
== Performance and Testing ==
+
== Multiple Properties ==
Auto actions will test up to 1000 bookings per cycle, if your trigger condition involves more than 1000 bookings, the next 1000 will be tested on the next cycle etc.
+
 
If you require the fastest speed make sure your trigger is designed to test less than 1000 bookings.
+
With Multiple Properties, the requirement to have Property specific information in the Messages/emails sent to the guest/housekeeping/owner can be achieved using Template Variables.  
 +
 
 +
When you create a Property/Room in Beds24, the setup of the Property/Room is held in the database and can be accessed via Template Variables. For example in {{#fas:cog}} (SETTINGS) >PROPERTIES >DESCRIPTION, you setup the property specific details.  
  
The easiest way to do this is usually by reducing the testing window to the smallest necessary and adjusting the trigger condition to the most suitable.
+
*Property name - can be accessed in template variable [PROPERTYNAME]
For example a trigger that tests all bookings from booking time for 1 year will test many bookings while a trigger that tests only the 7 days before check-in will test less bookings and perform faster.
+
*Property Address - can be accessed in template variable [PROPERTYADDRESS]
  
The test tab of the auto action has a button which will show you how many and which bookings are being tested by the auto action.
+
You will find the full list of Property Template Variables when you go to [[Template_Variables#Property_Variables|Property Variables]]
  
It is also possible to specify a booking number and test if the auto action would trigger on that booking with some diagnostics information shown to help trouble shooting.
+
There are additional Property Templates that can be used in Messages/Emails/SMS to the guest that can be customised for each Property. Each Property Template can hold customised text that can be used in Auto Actions, Booking Templates, Invoices and Reports.  
  
== Troubleshooting ==
+
Go to {{#fas:cog}} (SETTINGS) >PROPERTIES >DESCRIPTION >PROPERTY TEMPLATES you will see the list that are available.  
'''If Auto Actions do not send:'''
 
The list in the "Mail" tab of the booking will tell you why. Common causes are:
 
*Is your outgoing Email address working? Go to SETTINGS->ACCOUNT->OUTGOING EMAIL and click on "Send Test Email".
 
*Is your Auto Action set to send automatically?
 
*Is the guests Email address valid ("Mails" tab of the booking)?
 
*Is the booking set to allow Allow Auto Actions ("Mails" tab of the booking)?
 
*Do all trigger events apply to the booking?
 
  
'''Delayed trigger of Auto Action:'''
+
When you create each Room/Unit the information is held in Room/Unit specific template variables.  
See section Performance and testing above.  
 
  
'''Auto Action is not editable'''
+
You will find the full list of Room/Unit Template Variables when you go to [[Template_Variables#Room_Variables|Room Variables]]
To have write access to an auto action an account needs to have write access to all properties to which the auto action applies. This might not be the case if you use sub accounts and the Auto Action is set to trigger for "All Properties".
 
  
'''You don't have permission to access control2.php on this server''' error message, when the save button is clicked
+
See the full list of [[Template Variables]].  
It is most likely something in your content triggering the firewall.
+
 
Try adding the content bit by bit until you find the item causing the problem.
+
You can send a message/email to your guests, confirming their booking date, property details and property contact details. Use the property, room and booking templates to build the message/email in one Auto Action, rather than one auto action per property.  
Often it is a script or HTML item that appears to the firewall as a possible hacking attack.
+
 
It can also be something that looks innocent like a combination of numbers and words like "and" or "or" that hackers often use in sql injection attacks.
+
This approach will reduce the ongoing management, update one Auto Action and it will apply to all/selected properties rather than having to edit multiple auto actions with the same overall message.
Once you find the item causing the problem, try rewording it.
 
  
== Examples ==
+
===Example 1 - Each property has a different access code for the main building door ===  
  
=== Send Emails/Message/SMS to guests ===
+
Your properties have security doors with keycodes, each property has a different code.
  
Message API messages will be shown in the message tab of the booking and in the Channel Message centre. Currently this is only available for Booking.com and Airbnb.  
+
Go to {{#fas:cog}} (SETTINGS) >PROPERTIES >DESCRIPTION >PROPERTY TEMPLATES > Property Template 1 enter the Building Access Code, use this same field in each property and set the appropriate code.  
  
<div class="mw-collapsible mw-collapsed">
+
Then in the Auto Action use [PROPERTYTEMPLATE1] in the text rather than the actual value.
<div  class="headline-collapse" >
 
====Send an Email to the guest when the status of a booking changes to  "Cancelled"====
 
</div>
 
<div class="mw-collapsible-content">
 
  
Trigger tab:
+
*Please use this code to Access the Main building Door:- [PROPERTYTEMPLATE1]
*Trigger Event = Check-in
 
*Trigger Time = -365
 
*Trigger Window = 365
 
*Booking Source = All (for example)
 
*Booking Status = Cancelled
 
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
+
There is no need for a separate auto action due to the front door keycode being different.
  
*'''Send Message''' = Booking API/Smart Email
+
===Example 2 - Housekeeping/Cleaning Team is different for each Property. ===
  
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
+
Each of your properties has a different housekeeping/cleaning team and you need to send them an email with the booking details for each booking.  
  
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
+
Go to {{#fas:cog}} (SETTINGS) >PROPERTIES >DESCRIPTION >PROPERTY TEMPLATES > Property Template 5 enter the email address for Housekeeping/Cleaning team.  
  
*'''Email Subject''' - enter the subject for your Guests
+
In the Auto action,
 +
*"Send Message" = Internal Only.
 +
*"Internal Email Address" = [PROPERTYTEMPLATE5]
  
*'''Plain Text Box''' - will send to channels using Message API
+
There is no need for a separate auto action as the message will be sent to the appropriate email from property template 5.
  
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
+
If you have different teams per room, then use a Room template rather than the Property Template.
  
*'''HTML box''' - Email will be sent
+
===Example 3 - Send email to a Group of Properties (not all) ===
  
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
+
You can setup a "Group" for your Properties, this has a number of benefits, including sending/excluding messages/emails to a Group of Properties, view a "Group" of properties in your Calendar and in Reports.  
  
 +
To assign the "Group" to your Properties, go to {{#fas:cog}} (SETTINGS) > BOOKING ENGINE > MULTI BOOKING PAGE > PROPERTY SETTINGS > GROUP KEYWORDS.
  
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> If you are using deposit collection make sure you set SETTINGS->PAYMENTS->PAYMENT COLLECTION "Non Payment Booking Status" = Request.
+
Enter a Group name, it needs to be a single word - for example you want to identify all 4 bedroom properties, then you can add 4BEDS and add this to all 4 Bedroom properties you have.  
  
</div>
+
Each property can be in multiple groups, enter multiple keywords separated by a comma, for example :- 4BEDS, OceanView, Dublin.
</div>
 
  
<div class="mw-collapsible mw-collapsed">
+
In the Trigger tab of the Auto Action,  enter the Group keyword in
<div  class="headline-collapse" >
+
*"Send Only To Property Groups" OR "Exclude Property Groups" you want to include/exclude from the Auto Action.
  
====Change the status of all upcoming direct bookings to "Cancelled"  and send an Email to the guest ====
+
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> This filter will not apply if you are triggering on a single property.
</div>
 
<div class="mw-collapsible-content">
 
Trigger tab:
 
*Trigger Event = Check-in
 
*Trigger Time = -14 (for example to cancel the bookings for the next two weeks)
 
*Trigger Window = 14
 
*Booking Source = Direct
 
*Booking Status = All Not Cancelled
 
  
Booking tab:
+
== Using Smart Logic Template Variables ==
*Booking Status  = Cancelled
+
You can use smart logic template variables to trigger auto actions for specific conditions.
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
+
If you want to send a message on a specific day of the week :-
  
*'''Send Message''' = Booking API/Smart Email
+
1) You need to send a message to remind the guests to put the rubbish bin out for collection on a Wednesday night.
 +
* [IF=:[CURRENTDATE:{%u}]:3:yes|no] will test if the current date is a Wednesday
  
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
+
2) Remind the guest that the cleaning lady will be at the apartment on Friday morning.  
  
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
+
* [IF=:[CURRENTDATE:{%u}]:4:yes|no] will test if the current date is a Thursday
  
*'''Email Subject''' - enter the subject for your Guests
+
%u ISO-8601 numeric representation of the day of the week 1 (for Monday) through 7 (for Sunday)
  
*'''Plain Text Box''' - will send to channels using Message API
+
== Performance and Testing ==
 +
Auto actions will test up to 1000 bookings per cycle, if your trigger condition involves more than 1000 bookings, the next 1000 will be tested on the next cycle etc.
 +
If you require the fastest speed, ensure your trigger is designed to test less than 1000 bookings.
  
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
+
The easiest way to do this is usually by reducing the testing window to the smallest necessary and adjusting the trigger condition to the most suitable.
 +
For example a trigger that tests all bookings from booking time for 1 year will test many bookings while a trigger that tests only the 7 days before check-in will test less bookings and perform faster.
  
*'''HTML box''' - Email will be sent
+
The test tab of the auto action has a button that will show you how many and which bookings are being tested by the auto action.
  
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
+
It is also possible to specify a booking number and test if the auto action would trigger on that booking with some diagnostics information shown to help trouble shooting.
  
</div>
+
'''Optimising your auto actions''' You can trigger multiple actions in one auto action,
</div>
+
*send an email/api message to the guest,
 +
*send an SMS, update booking settings,
 +
*add/delete a booking info code,
 +
*trigger a webook,
 +
*add a pending payment,
 +
*update/add/delete a Charge/Payment item,
 +
*assign an invoice number.
  
<div class="mw-collapsible mw-collapsed">
+
There is no requirement to set an individual auto action for each item if they can all apply at the same time.
<div  class="headline-collapse" >
 
  
====Send an message or SMS to Guest when booking made more than 10 days in advance====
+
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> '''It is not possible to specify a specific time for the auto action to trigger.'''  The use of the Trigger time 'Immediate' + 14 hrs (for example) will not trigger the auto action at 2pm local time, this will be the first time the booking could be checked to see if all other conditions are met, and added to the batch for processing.
</div>
 
<div class="mw-collapsible-content">
 
Trigger tab:
 
*Trigger Event = Check-in
 
*Trigger Time = -365 days
 
*Trigger Window = 355 days
 
*Booking Status = All not cancelled
 
  
Booking tab:
+
== Troubleshooting ==
*Execution = One time only
+
'''If Auto Actions do not send:'''
*Booking Status = No Change
+
The list in the "Mail" tab of the booking will tell you why. Common causes are:
 +
*Is your outgoing Email address working? Go to {{#fas:cog}} (SETTINGS) ACCOUNT->OUTGOING EMAIL and click on "Send Test Email".
 +
*Is your Auto Action set to send automatically?
 +
*Is the guests Email address valid ("Mails" tab of the booking)?
 +
*Is the Plain Text box populated with the text you want to send (required when Message API is being used?
 +
*Is the booking set to allow Allow Auto Actions ("Mails" tab of the booking)?
 +
*Do all trigger events apply to the booking?
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
+
'''Delayed trigger of Auto Action:'''
 +
See section Performance and testing above.  
  
*'''Send Message''' = Booking API/Smart Email
+
'''Auto Action is not editable'''
 +
To have write access to an auto action an account needs to have write access to all properties to which the auto action applies. This might not be the case if you use sub accounts and the Auto Action is set to trigger for "All Properties".
  
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
+
'''You don't have permission to access control2.php on this server''' error message, when the save button is clicked
 +
It is most likely something in your content triggering the firewall.
 +
Try adding the content bit by bit until you find the item causing the problem.
 +
Often it is a script or HTML item that appears to the firewall as a possible hacking attack.
 +
It can also be something that looks innocent like a combination of numbers and words like "and" or "or" that hackers often use in sql injection attacks.
 +
Once you find the item causing the problem, try rewording it.
  
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
+
'''Auto Action is not visible in a sub account'''
 +
If you have sub accounts and need an auto action to be used across multiple accounts/properties, then create the auto action at the Master Account Level and set Property = 'All visible in account' and ensure the Master account has access to the properties.
  
*'''Email Subject''' - enter the subject for your Guests
+
== Examples ==
  
*'''Plain Text Box''' - will send to channels using Message API
+
=== Send Emails/Message/SMS to guests ===
  
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
+
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span>  Message API messages will be shown in the message tab of the booking and in the Channel Message centre. Currently this is only available for Booking.com and Airbnb.  
  
*'''HTML box''' - Email will be sent
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Send an Email to the guest when the status of a booking changes to  "Cancelled"====
 +
</div>
 +
<div class="mw-collapsible-content">
  
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
+
'''Trigger tab:'''
  
 +
Time:
 +
*Trigger Event = Check-in
 +
*Trigger Time = -365
 +
*Trigger Window = 365
  
SMS tab :
+
Booking Source
 +
*Booking Source = All (for example)
  
Please note a charge applies per SMS message.
+
Booking Conditions
 +
*Booking Status = Cancelled
  
*Send SMS Message : Enable
+
'''Message tab''': For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
*Phone Number : This is the phone number that will receive the SMS notification.
 
  
This is a global service and the notifications can be sent to almost phone in any country.
+
*Send Message = Booking API/Smart Email
  
The phone number must contain the international country code and phone number as it would be dialed internationally.
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
  
Do not include any leading zeros or other characters and use no spaces.
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
  
The number must start with the country code.
+
*Email Subject - enter the subject for your Guests
  
EXAMPLE
+
*Plain text box - will send to channels using Message API
  
to send to phone number 015625346 in the UK (Country code 44) enter the following number
+
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
  
4415625346
+
*HTML box - Email will be sent
  
You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.
+
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
  
*SMS Message
 
  
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
+
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> If you are using deposit collection make sure you set {{#fas:cog}} (SETTINGS)  PAYMENTS->PAYMENT COLLECTION "Non Payment Booking Status" = Request.
  
 
</div>
 
</div>
Line 292: Line 386:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send an message or SMS to Guest when booking made more than 7 days in advance====
+
====Change the status of all upcoming direct bookings to "Cancelled"  and send an Email to the guest ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Alternatively you an use Between Booking and Check in
+
'''Trigger tab:'''
  
Trigger tab:
+
Time:  
*Trigger Event = Booking (but not after check-in)
+
*Trigger Event = Check-in
*Trigger Time = Immediate
+
*Trigger Time = -14 (for example to cancel the bookings for the next two weeks)
*Trigger Window = 1 day
+
*Trigger Window = 14
Between Booking and Check in = 7 to 999
+
 
*Booking Status = All not cancelled
+
Booking Source:
 +
*Booking Source = Direct
 +
 
 +
Booking Conditions:
 +
*Booking Status = All Not Cancelled
  
Booking tab:
+
Booking tab:  
*Execution = One time only
+
*Booking Status = Cancelled
*Booking Status = No Change
 
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
+
'''Message tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
  
*'''Send Message''' = Booking API/Smart Email
+
*Send Message = Booking API/Smart Email
  
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
  
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 +
 +
*Email Subject - enter the subject for your Guests
  
*'''Email Subject''' - enter the subject for your Guests
+
*Plain Text Box - will send to channels using Message API
 
 
*'''Plain Text Box''' - will send to channels using Message API
 
  
 
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
 
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
  
*'''HTML box''' - Email will be sent
+
*HTML box - Email will be sent
  
 
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
 
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
  
 +
</div>
 +
</div>
  
SMS tab :
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
  
Please note a charge applies per SMS message.
+
====Send an message or SMS to Guest when booking made more than 10 days in advance====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
'''Trigger tab:'''
  
*Send SMS Message : Enable
+
Time:
*Phone Number : This is the phone number that will receive the SMS notification.
+
*Trigger Event = Check-in
 +
*Trigger Time = -365 days
 +
*Trigger Window = 355 days
 +
 
 +
Booking Conditions:
 +
*Booking Status = All not cancelled
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Booking Status = No Change
 +
 
 +
'''Message tab''': For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
 +
 
 +
*Send Message = Booking API/Smart Email
 +
 
 +
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 +
 
 +
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 +
 
 +
*Email Subject - enter the subject for your Guests
 +
 
 +
*Plain Text Box - will send to channels using Message API
 +
 
 +
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
 +
 
 +
*HTML box - Email will be sent
 +
 
 +
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
 +
 
 +
 
 +
'''SMS tab :'''
 +
 
 +
Please note a charge applies per SMS message.
 +
 
 +
*Send SMS Message : Enable
 +
*Phone Number : This is the phone number that will receive the SMS notification.
  
 
This is a global service and the notifications can be sent to almost phone in any country.
 
This is a global service and the notifications can be sent to almost phone in any country.
Line 353: Line 491:
  
 
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
 
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
 +
 
</div>
 
</div>
 
</div>
 
</div>
Line 359: Line 498:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send an message or SMS to Guest when booking made more last minute booking - 6 days or less====
+
====Send an message or SMS to Guest when booking made more than 7 days in advance====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
Alternatively you an use Between Booking and Check in
  
Trigger tab:
+
'''Trigger tab:'''
 +
 
 +
Time:
 
*Trigger Event = Booking (but not after check-in)
 
*Trigger Event = Booking (but not after check-in)
 
*Trigger Time = Immediate
 
*Trigger Time = Immediate
 
*Trigger Window = 1 day
 
*Trigger Window = 1 day
Between Booking and Check in = 0 to 6
+
*Between Booking and Check in = 7 to 999
 +
 
 +
Booking Conditions:
 
*Booking Status = All not cancelled
 
*Booking Status = All not cancelled
  
Booking tab:
 
*Execution = One time only
 
*Booking Status = No Change
 
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
+
'''Message tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
  
*'''Send Message''' = Booking API/Smart Email
+
*Send Message = Booking API/Smart Email
  
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
Line 382: Line 523:
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
  
*'''Email Subject''' - enter the subject for your Guests
+
*Email Subject - enter the subject for your Guests
  
*'''Plain Text Box''' - will send to channels using Message API
+
*Plain text box - will send to channels using Message API
  
 
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
 
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
  
*'''HTML box''' - Email will be sent
+
*HTML box - Email will be sent
  
 
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
 
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
  
  
SMS tab :
+
'''SMS tab :'''
  
 
  Please note a charge applies per SMS message.  
 
  Please note a charge applies per SMS message.  
Line 419: Line 560:
  
 
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
 
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
 +
 +
'''Booking tab:'''
 +
*Execution = One time only
 +
*Booking Status = No Change
  
 
</div>
 
</div>
Line 426: Line 571:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send an Email with a key code for a specific unit one day before check-in====
+
====Send an message or SMS to Guest for last minute booking - 6 days or less====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
+
 
*Trigger Event = Check-in
+
'''Trigger tab:'''
*Trigger Time = -1 day
+
 
*Trigger Window = 1 day  
+
Time:
 +
*Trigger Event = Booking (but not after check-in)
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
 +
*Between Booking and Check in = 0 to 6
 +
 
 +
Booking Conditions:
 
*Booking Status = All not cancelled
 
*Booking Status = All not cancelled
*Unit = Select the number of the unit you want to send this message to. Note that the number represents the index of the unit not its name.
 
  
Booking tab:
 
*Execution = One time only
 
*Booking Status = No Change
 
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
+
'''Message tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
  
*'''Send Message''' = Booking API/Smart Email
+
*Send Message = Booking API/Smart Email
  
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
Line 448: Line 595:
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
  
*'''Email Subject''' - enter the subject for your Guests
+
*Email Subject - enter the subject for your Guests
  
*'''Plain Text Box''' - will send to channels using Message API
+
*Plain text box - will send to channels using Message API
  
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
+
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
  
If you are using the "Additional Information" function SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables
+
*HTML box - Email will be sent
  
Example: Your room is [UNITNAME]. Check-in from: [UNITNAME:1] . The key code is: [UNITNAME:2]  
+
Email Text :- It is possible to use the same details (URL) as in the Plain text box above. Template variables can be used [[Template_Variables| see here]]
  
The template variables will only work if you have entered text in SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names". The context help for this setting will explain how to do this.
 
  
 +
'''SMS tab :'''
  
*'''HTML box''' - Email will be sent
+
Please note a charge applies per SMS message.
  
If you are using the "Additional Information" function SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables [[Template_Variables| see here]]
+
*Send SMS Message : Enable
 +
*Phone Number : This is the phone number that will receive the SMS notification.
 +
 
 +
This is a global service and the notifications can be sent to almost phone in any country.
 +
 
 +
The phone number must contain the international country code and phone number as it would be dialed internationally.
 +
 
 +
Do not include any leading zeros or other characters and use no spaces.
 +
 
 +
The number must start with the country code.
 +
 
 +
EXAMPLE
 +
 
 +
to send to phone number 015625346 in the UK (Country code 44) enter the following number
 +
 
 +
4415625346
 +
 
 +
You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.
 +
 
 +
*SMS Message
  
Example: Your room is [UNITNAME]. Check-in from: [UNITNAME:1] . The key code is: [UNITNAME:2]
+
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
  
The template variables will only work if you have entered text in SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names". The context help for this setting will explain how to do this.
+
'''Booking tab:'''
 +
*Execution = One time only
 +
*Booking Status = No Change
  
 
</div>
 
</div>
Line 475: Line 643:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send an Email to the guest when a payment is made====
+
====Send an Email with a key code for a specific unit one day before check-in (Self Checkin)====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
+
'''Trigger tab:'''
*Trigger Event = After Booking
 
*Trigger Time =  Immediate
 
*Trigger Window =  365 day
 
*Booking Status = All not cancelled
 
*Invoice Balance = Any Payment made OR Invoice Balance = Zero (payment in full)
 
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
+
Property, Room, Unit:
 +
*Unit = Select the number of the unit you want to send this message to. Note that the number represents the index of the unit not its name.  
  
*'''Send Message''' = Booking API/Smart Email
+
Time:
 +
*Trigger Event = Check-in
 +
*Trigger Time =  -1 day
 +
*Trigger Window =  1 day
 +
 
 +
Booking Conditions
 +
*Booking Status = All not cancelled
 +
 
 +
'''Message tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
 +
 
 +
*Send Message = Booking API/Smart Email
  
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
Line 493: Line 667:
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
  
*'''Email Subject''' - enter the subject for your Guests
+
*Email Subject - enter the subject for your Guests
  
*'''Plain Text Box''' - will send to channels using Message API
+
*Plain text box - will send to channels using Message API
  
 
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
 
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
  
You should consider adding the invoice table to the email so the guest can see the booking details including Charges & Payments.  
+
If you are using the "Additional Information" function {{#fas:cog}} (SETTINGS)  PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables
 +
 
 +
Example: Your room is [UNITNAME]. Check-in from: [UNITNAME:1] . The key code is: [UNITNAME:2]
  
[INVOICETABLE] - invoice table
+
The template variables will only work if you have entered text in {{#fas:cog}} (SETTINGS)  PROPERTIES->ROOMS->SET UP "Unit Names". The context help for this setting will explain how to do this.
  
It is also possible to include a customised invoice table using this template variable :- [INVOICE:PRI_QTY_CUA€] will create an invoice table with price and quantity in Euros.
 
  
*'''HTML box''' - Email will be sent
+
*HTML box - Email will be sent
  
Email Text :- It is possible to use the same details as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
+
If you are using the "Additional Information" function SETTINGS-{{#fas:cog}} (SETTINGS) PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables [[Template_Variables| see here]]
  
You should consider adding the invoice table to the email so the guest can see the booking details including Charges & Payments.  
+
Example: Your room is [UNITNAME]. Check-in from: [UNITNAME:1] . The key code is: [UNITNAME:2]
  
[INVOICETABLE] - invoice table
+
The template variables will only work if you have entered text in S{{#fas:cog}} (SETTINGS) PROPERTIES->ROOMS->SET UP "Unit Names". The context help for this setting will explain how to do this.
  
It is also possible to include a customised invoice table using this template variable :- [INVOICE:PRI_QTY_CUA€] will create an invoice table with price and quantity in Euros.
+
'''Booking tab:'''
 +
*Execution = One time only
 +
*Booking Status = No Change
  
 
</div>
 
</div>
Line 521: Line 698:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send an Email to guests from Channels====
+
====Send an Email to the guest when a payment is made====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
+
'''Trigger tab:'''
*Trigger Event = After Booking
 
*Trigger Time = Immediate
 
*Trigger Window = 1 day
 
*Booking Source = Channel Manager
 
  
Booking tab:
+
Time:
*Execution = One time only
+
*Trigger Event = Booking
*Booking Status = No Change
+
*Trigger Time = Immediate
 +
*Trigger Window = 365 day
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
+
Booking Conditions:
 +
*Booking Status = All not cancelled
 +
*Invoice Balance = Any Payment made OR Invoice Balance = Zero (payment in full)
 +
 
 +
'''Message tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
  
*'''Send Message''' = Booking API/Smart Email
+
*Send Message = Booking API/Smart Email
  
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
Line 542: Line 720:
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
  
*'''Email Subject''' - enter the subject for your Guests
+
*Email Subject - enter the subject for your Guests
  
*'''Plain Text Box''' - will send to channels using Message API
+
*Plain text box - will send to channels using Message API
  
 
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
 
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
  
 +
You should consider adding the invoice table to the email so the guest can see the booking details including Charges & Payments.
 +
 +
[INVOICETABLE] - invoice table
 +
 +
It is also possible to include a customised invoice table using this template variable :- [INVOICE:PRI_QTY_CUA€] will create an invoice table with price and quantity in Euros
  
*'''HTML box''' - Email will be sent
+
*HTML box - Email will be sent
  
Email Text :- It is possible to use the same details as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
+
Email Text :- It is possible to use the same details as in the Plain text box above. Template variables can be used [[Template_Variables| see here]]
 +
 
 +
You should consider adding the invoice table to the email so the guest can see the booking details including Charges & Payments.
 +
 
 +
[INVOICETABLE] - invoice table
 +
 
 +
It is also possible to include a customised invoice table using this template variable :- [INVOICE:PRI_QTY_CUA€] will create an invoice table with price and quantity in Euros.
  
 
</div>
 
</div>
 
</div>
 
</div>
 
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send a message (Email or sms) to guests that have Checked-out 30 days or more====
+
====Apply a flag/colour to a booking when a payment is made - ''Select from the predefined template ''====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
+
'''Trigger tab:'''
*Trigger Event = After Check-out
 
*Trigger Time = 30 days
 
*Trigger Window = 365 days
 
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
+
Time:
 +
*Trigger Event = Booking
 +
*Trigger Time =  Immediate
 +
*Trigger Window =  999 day
  
*'''Send Message''' = Booking API/Smart Email
+
Booking Conditions:
 +
*Booking Status = All not cancelled
 +
*Invoice Balance = Any Payment made
  
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
+
'''Booking tab:'''
  
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
+
*Flag Text = Paid
 +
*Flag Colour = d4e4b0
  
*'''Email Subject''' - enter the subject for your Guests
+
</div>
 +
</div>
  
*'''Plain Text Box''' - will send to channels using Message API
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
  
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
+
====Email confirmation for channel bookings - ''Select from the predefined template''====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
'''Trigger tab:'''
  
 +
Time
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
  
*'''HTML box''' - Email will be sent
+
Booking Source
 +
*Booking Source = Channel Manager
  
Email Text :- It is possible to use the same details as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
+
'''Message tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.  
  
SMS tab :
+
*Send Message = Booking API/Smart Email
  
Please note a charge applies per SMS message.  
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
  
*Send SMS Message : Enable
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
*Phone Number : This is the phone number that will receive the SMS notification.
 
  
This is a global service and the notifications can be sent to almost phone in any country.
+
*Email Subject - enter the subject for your Guests
  
The phone number must contain the international country code and phone number as it would be dialed internationally.
+
*Plain text box - will send to channels using Message API
  
Do not include any leading zeros or other characters and use no spaces.
+
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
  
The number must start with the country code.
+
*HTML box - Email will be sent
  
EXAMPLE
+
Email Text :- It is possible to use the same details as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
  
to send to phone number 015625346 in the UK (Country code 44) enter the following number
+
'''Booking tab:'''
 +
*Execution = One time only
 +
*Booking Status = No Change
  
4415625346
+
</div>
 +
</div>
  
You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
  
*SMS Message
+
====Send a message (Email or sms) to guests that have Checked-out 30 days or more====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
'''Trigger tab:'''
  
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
+
Time
 +
*Trigger Event = Check-out
 +
*Trigger Time = 30 days
 +
*Trigger Window = 365 days
  
Booking tab: (optional)
+
'''Message tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
*Execution = One time only
 
*Flag Text = The text you want to display
 
*Flag Colour - choose the flag colour
 
  
</div>
+
*Send Message = Booking API/Smart Email
</div>
 
  
<div class="mw-collapsible mw-collapsed">
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
<div  class="headline-collapse" >
 
  
====Send a Request for payment to your guests for all bookings====
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
</div>
 
<div class="mw-collapsible-content">
 
Trigger tab:
 
  
*Trigger Event = After Booking
+
*Email Subject - enter the subject for your Guests
*Trigger Time = Immediate
 
*Trigger Window = 1 day
 
Booking Source = ALL (or select the booking source/Channel)
 
  
Message tab: Update details as appropriate
+
*Plain text box - will send to channels using Message API
*Send Message = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
 
  
Plain Text (Using Message API)
+
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
*Subject - enter the subject for your Guests
 
*Plain Text Message :- enter the Message text you wish to send to your guests include the payment link
 
  
https://beds24.com/bookpay.php?bookid=[BOOKID]
+
*HTML box - Email will be sent
  
You can find extra options to add to the payment link if you want to refine the details
+
Email Text :- It is possible to use the same details as in the Plain text box above. Template variables can be used [[Template_Variables| see here]]
 
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
 
  
HTML Message (Send Email)
+
'''SMS tab :'''
*Email Subject - enter the subject for your Guests
+
 
*Email Text :- enter the Email text you wish to send to your guests include template variable
+
Please note a charge applies per SMS message.
[PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.  
+
 
 +
*Send SMS Message : Enable
 +
*Phone Number : This is the phone number that will receive the SMS notification.
 +
 
 +
This is a global service and the notifications can be sent to almost phone in any country.
 +
 
 +
The phone number must contain the international country code and phone number as it would be dialed internationally.
 +
 
 +
Do not include any leading zeros or other characters and use no spaces.
 +
 
 +
The number must start with the country code.
 +
 
 +
EXAMPLE
 +
 
 +
to send to phone number 015625346 in the UK (Country code 44) enter the following number
 +
 
 +
4415625346
 +
 
 +
You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.
 +
 
 +
*SMS Message
  
Booking tab:
+
Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.
  
 +
'''Booking tab:''' (optional)
 
*Execution = One time only
 
*Execution = One time only
 
*Flag Text = The text you want to display
 
*Flag Text = The text you want to display
 
*Flag Colour - choose the flag colour
 
*Flag Colour - choose the flag colour
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
+
 
 
</div>
 
</div>
 
</div>
 
</div>
Line 665: Line 880:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send a Request for payment to your guests XX days before arrival====
+
====Send a Request for payment to your guests for all bookings====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
+
'''Trigger tab:'''
  
*Trigger Event = Check-in
+
Time
*Trigger Time = -42
+
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 
*Trigger Window = 1 day  
 
*Trigger Window = 1 day  
Booking Source = ALL (or select the booking source/Channel)
 
  
Message tab:  
+
Booking Source:
 +
*Booking Source = ALL (or select the booking source/Channel)
 +
 
 +
'''Message tab:''' Update details as appropriate
 +
*Send Message = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.
 +
If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
  
*Send Email :
+
*Plain text box (Using Message API)
**Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
 
**Booking API and Email: Messages are sent via channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
 
  
Plain Text (Using Message API)
+
Subject - enter the subject for your Guests
*Subject - enter the subject for your Guests
+
Plain Text Message :- enter the Message text you wish to send to your guests include the payment link  
*Plain Text Message :- enter the Message text you wish to send to your guests include the payment link  
 
  
 
https://beds24.com/bookpay.php?bookid=[BOOKID]
 
https://beds24.com/bookpay.php?bookid=[BOOKID]
Line 691: Line 908:
 
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
 
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
  
HTML Message (Send Email)  
+
*HTML Message (Send Email)  
*Edit Email Subject - enter the subject for your Guests
+
Email Subject - enter the subject for your Guests
*Edit Email Text :- enter the Email text you wish to send to your guests include template variable  
+
Email Text :- enter the Email text you wish to send to your guests include template variable  
 
[PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.  
 
[PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.  
  
 
+
'''Booking tab:'''
Booking tab:
 
 
 
 
*Execution = One time only
 
*Execution = One time only
 
*Flag Text = The text you want to display
 
*Flag Text = The text you want to display
 
*Flag Colour - choose the flag colour
 
*Flag Colour - choose the flag colour
 
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
 
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
 +
 
</div>
 
</div>
 
</div>
 
</div>
Line 709: Line 925:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send a Request for payment to your guests XX days after booking====
+
====Send a Request to update the guest's credit card as it will expire before checkin====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
'''Trigger tab:'''
  
You allow your guests to make X number of payments for their booking.
+
Time:
 +
*Trigger Event = Booking (not after check-in)
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day 
  
You can not trigger the auto action multiple times, unless you manage this manually, therefore you need to create multiple auto actions, so if you allow 3 payments for their booking, then you will need 3 auto actions.
+
Booking Souce:
 +
*Booking Source = ALL (or select the booking source/Channel)
  
You will need to manually add a Booking Info Code to each booking that you have agreed to allow X payments.
+
'''Message tab:'''
  
'''Create Auto Action one'''
+
*Send Email = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.
 +
If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
  
Trigger tab:
+
*Plain text box (Using Message API)
 +
Subject - enter the subject for your Guests
 +
Plain Text Message :- enter the Message text you wish to send to your guests including the payment link
  
*Trigger Event = Booking (but not after check-in)
+
https://beds24.com/bookpay.php?bookid=[BOOKID]&g=cc
*Trigger Time = +7 days
 
*Trigger Window = 1 day
 
  
*Booking Source = ALL (or select the booking source/Channel)
+
You can find extra options to add to the payment link if you want to refine the details
*Invoice Balance = Not Zero
+
*Any Booking Info Code = MULTIPLE (for example) this can be used if you only allow some guests to make multiple payments.  
+
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
  
Message tab:  
+
*HTML Message (Send Email)
 +
Edit Email Subject - enter the subject for your Guests
 +
Edit Email Text :- enter the Email text you wish to send to your guests including the payment link
  
*'''Send Message''' = Booking API/Smart Email
+
https://beds24.com/bookpay.php?bookid=[BOOKID]&g=cc this creates a link (HTML A tag) so the guest can enter their credit card details. Check the template variables for other options.  
**Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
 
**Booking API and Email: Messages are sent via channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
 
  
Plain Text (Using Message API)
+
'''Booking tab:'''
*Subject - enter the subject for your Guests
 
*Plain Text Message :- enter the Message text you wish to send to your guests include the payment link
 
 
 
https://beds24.com/bookpay.php?bookid=[BOOKID]
 
 
 
You can find extra options to add to the payment link if you want to refine the details
 
 
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
 
 
 
HTML Message (Send Email)
 
*Edit Email Subject - enter the subject for your Guests
 
*Edit Email Text :- enter the Email text you wish to send to your guests include template variable
 
[PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.
 
 
 
 
 
Booking tab:
 
  
 
*Execution = One time only
 
*Execution = One time only
Line 760: Line 966:
 
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
 
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
  
'''Create additional Auto Actions for each period you want to trigger'''
+
'''Booking Info tab:'''
 
 
'''Create Auto Action 2 (and 3, 4, 5 - how many you need) '''
 
*Trigger Time = +14 days (days you want to collect the payments)
 
*Trigger Window = 1 day
 
  
The use the settings in the previous auto action to trigger the next auto action for your booking.
+
*Booking Info Code = NEWCARDREQ
 +
*Booking Info Text = New credit card requested
  
 
</div>
 
</div>
 
</div>
 
</div>
 
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send a Request to 'Capture' a Security deposit from your guests XX days before check-in - with Stripe====
+
====Send a Request for payment to your guests XX days before check-in====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
'''Trigger tab:'''
 +
 +
Time:
 +
*Trigger Event = Check-in
 +
*Trigger Time = -42
 +
*Trigger Window = 42 day
  
You want to capture a Security Deposit for bookings on the day before check-in from your guest.
+
Booking Souce:
 +
*Booking Source = ALL (or select the booking source/Channel)
  
Capture of the payment is only held by Stripe for 7 days, if the guest is staying longer you will need to send the request again.
+
'''Message tab:'''
  
You will need to create multiple emails to capture the payment multiple times for the same booking.
+
*Send Email = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.
 +
If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
  
 +
*Plain text box (Using Message API)
 +
Subject - enter the subject for your Guests
 +
Plain Text Message :- enter the Message text you wish to send to your guests include the payment link
  
'''Create Auto Action one'''
+
https://beds24.com/bookpay.php?bookid=[BOOKID]
Trigger tab:
 
  
*Trigger Event = Check-in
+
You can find extra options to add to the payment link if you want to refine the details
*Trigger Time = -1 days
+
*Trigger Window = 1 day
+
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
*Booking Source = ALL (or select the booking source/Channel)
 
*Status = All not cancelled
 
  
Message tab:  
+
*HTML Message (Send Email)
 +
Edit Email Subject - enter the subject for your Guests
 +
Edit Email Text :- enter the Email text you wish to send to your guests include template variable
 +
[PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.
  
Send Email : select the appropriate option
+
'''Booking tab:'''
  
*Email Subject - enter the subject for your Guests
+
*Execution = One time only
 +
*Flag Text = The text you want to display
 +
*Flag Colour - choose the flag colour
 +
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
  
 +
</div>
 +
</div>
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
  
*'''Send Message''' = Booking API/Smart Email
+
====Send a Request for payment to your guests XX days after booking====
 +
</div>
 +
<div class="mw-collapsible-content">
  
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
+
You allow your guests to make X number of payments for their booking.  
  
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
+
You can not trigger the auto action multiple times, unless you manage this manually, therefore you need to create multiple auto actions, so if you allow 3 payments for their booking, then you will need 3 auto actions.  
  
*'''Email Subject''' - enter the subject for your Guests
+
You will need to manually add a Booking Info Code to each booking that you have agreed to allow X payments.
  
*'''Plain Text Box''' - will send to channels using Message API
+
'''Create Auto Action one'''
  
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]], change the pay=100 to the value you require.
+
'''Trigger tab:'''
 
https://beds24.com/bookpay.php?bookid=[BOOKID]&g=st&capture=0&pay=100.
 
  
*'''HTML box''' - Email will be sent
+
*Trigger Event = Booking (but not after check-in)
 +
*Trigger Time = +7 days
 +
*Trigger Window = 1 day
  
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
+
*Booking Source = ALL (or select the booking source/Channel)
 +
*Invoice Balance = Not Zero
 +
*Any Booking Info Code = MULTIPLE (for example) this can be used if you only allow some guests to make multiple payments.
  
Booking info tab: (Optional)
+
'''Message tab:'''
  
*Booking Info Code = SECDEPOSIT (for example)
+
*Send Message = Booking API/Smart Email
*Booking Info Text =  Security deposit request sent.
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
  
 +
*Plain text box (Using Message API)
 +
Subject - enter the subject for your Guests
 +
Plain Text Message :- enter the Message text you wish to send to your guests include the payment link
  
 +
https://beds24.com/bookpay.php?bookid=[BOOKID]
  
</div>
+
You can find extra options to add to the payment link if you want to refine the details
</div>
+
 +
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
  
<div class="mw-collapsible mw-collapsed">
+
*HTML Message (Send Email)
<div  class="headline-collapse" >
+
Edit Email Subject - enter the subject for your Guests
 +
Edit Email Text :- enter the Email text you wish to send to your guests include template variable
 +
[PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.
  
====Send an Email in the guests language to an internal Email address ====
 
</div>
 
<div class="mw-collapsible-content">
 
This uses a smart template variable. In this example we check whether the guest booked in French. If yes, then we send a French text. If no, we send an English text.
 
  
Trigger tab:
+
'''Booking tab:'''
*Booking Field Contains - select "Language" in the next field enter: the short code for the language this Auto Action is for.
 
  
Email tab:
+
*Execution = One time only
*Enter the message in the appropriate language under your default language.
+
*Flag Text = The text you want to display
 +
*Flag Colour - choose the flag colour
 +
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
  
Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
+
'''Create additional Auto Actions for each period you want to trigger'''
 
 
*'''Send Message''' = Internal Only
 
 
 
*'''Internal Email Address''' = enter the email address this message should be sent to.
 
 
 
*'''Email Subject''' - enter the subject for your Guests
 
 
 
*'''HTML box''' - Email will be sent
 
 
 
*'''Email Text''' :- Template variables can be used in the message. [[Template_Variables| See here]]
 
  
 +
'''Create Auto Action 2 (and 3, 4, 5 - how many you need) '''
 +
*Trigger Time = +14 days (days you want to collect the payments)
 +
*Trigger Window = 1 day
  
 +
The use the settings in the previous auto action to trigger the next auto action for your booking.
  
 
</div>
 
</div>
Line 866: Line 1,087:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send SMS in a certain language (if it is the language of the booking) or a default language====
+
====Send a Request to 'Capture' a Security deposit from your guests XX days before check-in - with Stripe====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
This uses a smart template variable. In this example we check whether the guest booked in French. If yes, then we send a French text. If no, we send an English text.
 
  
Trigger tab: Whatever you want
+
You want to capture a Security Deposit for bookings on the day before check-in from your guest.
 +
 
 +
Capture of the payment is only held by Stripe for 7 days, if the guest is staying longer you will need to send the request again.
 +
 
 +
You will need to create multiple emails to capture the payment multiple times for the same booking.
  
Booking tab: Whatever you want
 
  
SMS tab:
+
'''Trigger tab:'''
*Phone Number = [GUESTMOBILE]
 
*SMS Message = [IF=:[GUESTLANGUAGE]:fr:French_text|English_text]
 
</div>
 
</div>
 
  
<div class="mw-collapsible mw-collapsed">
 
<div  class="headline-collapse" >
 
====Send Remotelock/Lockstate,  Nuki PIN or Chekin Link ====
 
</div>
 
<div class="mw-collapsible-content">
 
Trigger tab:
 
 
*Trigger Event = Check-in
 
*Trigger Event = Check-in
*Trigger Time = -2 (the number of days before check-in you want to sent the code or link)
+
*Trigger Time = -1 days
*Trigger Window = 2
+
*Trigger Window = 1 day
*Booking Source = All
+
*Booking Source = ALL (or select the booking source/Channel)
*Booking Status = All but not cancelled
+
*Status = All not cancelled
*Group bookings Trigger all on master
+
 
*Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL
+
'''Message tab''': For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
 +
 
 +
*Send Message = Booking API/Smart Email
 +
 
 +
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 +
 
 +
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 +
 
 +
*Email Subject - enter the subject for your Guests
 +
 
 +
*Plain text box - will send to channels using Message API
 +
 
 +
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]], change the pay=100 to the value you require.
 +
   
 +
https://beds24.com/bookpay.php?bookid=[BOOKID]&g=st&capture=0&pay=100.
 +
 
 +
*HTML box - Email will be sent
 +
 
 +
Email Text :- It is possible to use the same details (URL) as in the Plain text box above. Template variables can be used [[Template_Variables| see here]]
 +
 
 +
'''Booking info tab: (Optional)'''
 +
 
 +
*Booking Info Code = SECDEPOSIT (for example)
 +
*Booking Info Text =  Security deposit request sent.
  
Message tab:
 
*Send Email = Booking API/Email Smart
 
*EMail Subject = Your access code (your text)
 
*Email Text = Your text which includes the template variable  [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN]
 
 
</div>
 
</div>
 
</div>
 
</div>
Line 905: Line 1,137:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Send Email to all current guest ====
+
====Send an email to the guest email address when a payment FAILS at Stripe====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
 
Trigger tab:
 
Trigger tab:
*Trigger Event = Check-in
+
*Trigger Event = Booking
 
*Trigger Time = Immediate
 
*Trigger Time = Immediate
*Trigger Window = 14(the max number of days your guests can stay)
+
*Trigger Window = 365
 
*Booking Source = All
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Booking Status = All but not cancelled
*Group bookings =  Trigger all on master
+
*Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE
*Any Booking Info Code = CHECKIN
+
 
*Exclude Booking Info Code = CHECKOUT
+
'''Message tab:''' Update details as appropriate
 +
*Send Message = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.
 +
If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.
 +
 
 +
*Plain text box (Using Message API)
 +
 
 +
Subject - enter the subject for your Guests
 +
Plain Text Message :- enter the Message text you wish to send to your guests including the payment link
 +
 
 +
https://beds24.com/bookpay.php?bookid=[BOOKID]
 +
 
 +
You can find extra options to add to the payment link if you want to refine the details
 +
 +
https://wiki.beds24.com/index.php/Category:Payments#Payment_Request
 +
 
 +
*HTML Message (Send Email)
 +
Email Subject - enter the subject for your Guests
 +
Email Text :- enter the Email text you wish to send to your guests include template variable
 +
[PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.
  
Message tab:  
+
'''Booking tab:'''
*Send Email = Guest
+
*Execution = One time only
*EMail Subject = Enter the appropriate details
+
*Flag Text = The text you want to display
*Email Text = Your text which includes the details for your current guests.  
+
*Flag Colour - choose the flag colour
 +
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
  
It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div class="headline-collapse" >  
+
<div class="headline-collapse" >
====Send Email with a PDF attachment====
+
 
 +
====Send an Email in the guests language to an internal Email address ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
This uses a smart template variable. In this example we check whether the guest booked in French. If yes, then we send a French text. If no, we send an English text.
  
You can send Invoice or Booking Template attachments to your Guests.
+
'''Trigger tab:'''
  
Setup your Invoice or Booking Template, go to SETTINGS -> GUEST MANAGEMENT -> INVOICING or SETTINGS -> GUEST MANAGEMENT -> BOOKING TEMPLATES
+
Time:
 
+
*Trigger Event = Booking
Trigger tab:
 
*Trigger Event = Checkout
 
 
*Trigger Time = Immediate
 
*Trigger Time = Immediate
 
*Trigger Window = 1
 
*Trigger Window = 1
*Booking Source = All (or select the appropriate channel/Direct)
 
*Booking Status = All but not cancelled
 
*Group bookings =  Trigger all on master
 
*Any Booking Info Code = CHECKOUT
 
  
Message tab:  
+
Booking Source:
*Send Email = Guest API/Smart Email (or one of the other options)
+
*Booking Source = All (for example)
*Attachment = Select an option from the drop down list.  
+
 
*EMail Subject = Enter the appropriate details
+
Booking Conditions:
*Email Text = Your text which includes the details for your current guests.
+
*Booking Status = All Not Cancelled
 +
 
 +
Booking Fields:
 +
*Booking Field Contains - select "Language" in the next field enter: the short code for the language this Auto Action is for.
 +
 
 +
'''Message tab:'''
 +
Enter the message in the appropriate language under your default language.
 +
 
 +
*Send Message = Internal Only
 +
 
 +
*Internal Email Address = enter the email address this message should be sent to.
 +
 
 +
*Email Subject - enter the subject for your Guests
  
It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkout to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
+
*HTML box - Email will be sent
  
If you send Emails with pdf attachment (invoice, booking template) to Alias-Email addresses created by channels the channel might block the attachment so it is not delivered to the guest. Ask your channel about their policy regarding this.
+
*Email Text :- Template variables can be used in the message. [[Template_Variables| See here]]
  
Other files can not be attached. We recommend you use a link to a file you upload to your web site.
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
  
<div class="mw-collapsible mw-collapsed">
+
====Send SMS in a certain language (if it is the language of the booking) or a default language====
<div  class="headline-collapse" >
 
====Send Email after the cleaner has cleaned the room====
 
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
This uses a smart template variable. In this example the auto action will trigger on Booking and for 1 day, we check whether the guest booked in French. If yes, then we send a French text. If no, we send an English text.
 +
 +
'''Trigger tab:'''
  
To send an automated Email to the guest then they can check you/the cleaner have to add a unitstatus to the room when it is ready. In this example we used the unit status clean
+
Set the rules to when this Auto Action should trigger.
  
Trigger tab:
+
Time:
*Trigger Event = Checkin
+
*Trigger Event = Booking
 
*Trigger Time = Immediate
 
*Trigger Time = Immediate
 
*Trigger Window = 1
 
*Trigger Window = 1
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Group bookings =  Trigger all on master
 
*Template Variable = [UNITSTATUS1] Contains = clean
 
  
Message tab:  
+
Booking Source:
*Send Email = Guest API/Smart Email (or one of the other options)
+
*Booking Source = All (for example)
*EMail Subject = Enter the appropriate details
+
 
*Email Text = Your text.
+
Booking Conditions:
 +
*Booking Status = All Not Cancelled
  
  
Other files can not be attached. We recommend you use a link to a file you upload to your web site.
+
'''SMS tab:'''
 +
*Phone Number = [GUESTMOBILE]
 +
*SMS Message = [IF=:[GUESTLANGUAGE]:fr:French_text|English_text]
 
</div>
 
</div>
 
</div>
 
</div>
  
===Booking Info Codes===
 
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Add CHECKIN Booking info code to bookings ====
+
 
 +
====Send Remotelock/Lockstate,  Nuki PIN or Chekin Link 2 days before Check-in (Self Checkin) - ''Select from the predefined template'' ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
'''Trigger tab:'''
  
If you need to use the Booking info code CHECKIN/CHECKOUT for reporting/other auto actions, you can set the Booking info code rather than use the Current guest module in the dashboard.
+
Time:-
 +
*Trigger Event = Check-in
 +
*Trigger Time =  -2 (the number of days before check-in you want to sent the code or link)
 +
*Trigger Window = 2
  
Trigger tab:
+
Booking Souce :-  
*Trigger Event = Check-in
 
*Trigger Time = Immediate
 
*Trigger Window = 1 day
 
 
*Booking Source = All
 
*Booking Source = All
*Booking Status = All but not cancelled
+
*Booking Status = Confirmed
 +
 
 +
Booking Conditions:-
 
*Group bookings =  Trigger all on master
 
*Group bookings =  Trigger all on master
  
Booking Info tab:  
+
Info Codes :-
*Booking Info Code = CHECKIN
+
*Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL (select the appropriate Booking Info Code for the service you use)
*Booking Info Text = Auto Checkin
+
 
</div>
+
'''Messaging tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
</div>
+
 
 +
*Send Message = Booking API/Smart Email
  
<div class="mw-collapsible mw-collapsed">
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
<div class="headline-collapse" >
+
 
====Add CHECKOUT Booking info code to bookings ====
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
</div>
+
 
<div class="mw-collapsible-content">
+
*Subject - enter the subject for your Guests - Your access code (your text)
 +
 
 +
*Plain text box - will send to channels using Message API
 +
 
 +
Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]
  
If you need to use the Booking info code CHECKIN/CHECKOUT for reporting/other auto actions, you can set the Booking info code rather than use the Current guest module in the dashboard.
+
*HTML box - Email will be sent
  
Trigger tab:
+
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]
*Trigger Event = Check-out
 
*Trigger Time = Immediate
 
*Trigger Window = 1 day
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Group bookings =  Trigger all on master
 
  
Booking Info tab:
 
*Booking Info Code = CHECKOUT
 
*Booking Info Text = Auto Checkout
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Group check-in ====
+
 
 +
====Send Pin code to guest, 2 days before Check-in (Self Checkin) ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
This requires the master booking to be checked-in via the check-in function.
 
  
Trigger tab:
+
This auto action can be used if you have set a fixed PIN code in the Room Setup or using digits from the Booking id.
 +
 
 +
To setup the PIN code for each Room/Unit then go to {{#fas:cog}}  (SETTINGS) > PROPERTIES > ROOMS > SETUP > UNIT NAMES, then in the unit names, you can add additional information including a pin code.
 +
 
 +
Example:
  
*Trigger Event = After Booking
+
You have 2 units (100 and 101). Access Pin Code for 100 = 12345, for 101 - 34567
*Trigger Time =  immediately
+
 
*Trigger Window = 365
+
In "Unit name" enter: (Use (?) in the room setup for more details/options)
 +
 
 +
*100|12345
 +
*101|34567
 +
 
 +
'''Trigger tab:'''
 +
 
 +
Time:-
 +
*Trigger Event = Check-in
 +
*Trigger Time =  -2 (the number of days before check-in you want to sent the code or link)
 +
*Trigger Window = 2
 +
 
 +
Booking Souce :-
 
*Booking Source = All
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Booking Status = All but not cancelled
*Group bookings" =  Trigger all on master
 
*Info Code = CHECKIN
 
  
Booking info tab :  
+
Booking Conditions:-
*Info Code = CHECKIN
+
*Group bookings =  Trigger all on master
 +
 
 +
'''Messaging tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
 +
 
 +
*Send Message = Booking API/Smart Email
 +
 
 +
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 +
 
 +
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 +
 
 +
*Subject - enter the subject for your Guests - Your access code (your text)
 +
 
 +
*Plain text box - will send to channels using Message API
 +
 
 +
Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [UNITNAME] and [UNITNAME:1]  or [BOOKIDLAST5] - Last 5 digits of booking number. See the list of ALL template variables that can be used [[Template_Variables| see here]]
 +
 
 +
*HTML box - Email will be sent
 +
 
 +
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [UNITNAME] and [UNITNAME:1]  or [BOOKIDLAST5] - Last 5 digits of booking number. see the list of ALL template variables that can be used [[Template_Variables| see here]]
 +
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Identify Repeat Guest ====
+
 
 +
====Send Email to guests with check-in details 2 days before Check-in, booking paid/no outstanding balance ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
This requires you to use the Guest database.
 
  
Trigger tab:
+
This auto action will be sent only when the Invoice Balance of the booking is zero. This can be used to ensure that the checkin details are only sent when the guest has completed the payments.
 +
 
 +
'''Trigger tab:'''
 +
 
 +
Time:-
 +
*Trigger Event = Check-in
 +
*Trigger Time =  -2 (the number of days before check-in you want to sent the code or link)
 +
*Trigger Window = 2
  
*Trigger Event = After Booking
+
Booking Source:-
*Trigger Time =  immediately
 
*Trigger Window = 365
 
 
*Booking Source = All
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Booking Status = All but not cancelled
*Group bookings" =  Trigger all on master
 
*Template Variable = [GUESTSID1] greater than 0
 
  
Booking info tab :  
+
Booking Conditions:-
*Info Code = REPEAT
+
*Group bookings =  Trigger all on master
 +
*Invoice Balance = Zero
 +
 
 +
'''Messaging tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
 +
 
 +
*Send Message = Booking API/Smart Email
 +
 
 +
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 +
 
 +
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 +
 
 +
*Subject - enter the subject for your Guests - Your access code (your text)
 +
 
 +
*Plain text box - will send to channels using Message API
 +
 
 +
Message Text :- enter the text you wish to send to your guests. This can include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used [[Template_Variables| see here]]
 +
 
 +
*HTML box - Email will be sent
 +
 
 +
Email Text :- Enter the text you wish to send to your guests this can include URLs. Include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used [[Template_Variables| see here]]
 +
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Identify bookings with Custom Question ticked/unticked ====
+
 
 +
====Send Email to guests with check-in details 2 days before Check-in, Security Deposit Authorised at Stripe ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
If you have a custom question with a 'Tick box' for example, they want a late checkin.
 
  
Setup the custom question in  Properties -> Booking Questions -> Custom Questions -> Custom question 1, set with TYPE = Tick Box.  
+
This auto action will be sent only when the a payment has been 'authorised' at Stripe. This can be used to ensure that the checkin details are only sent when the guest has completed the Security Deposit Authorisation.  
  
Trigger tab:
+
'''Trigger tab:'''
 +
 
 +
Time:-
 +
*Trigger Event = Check-in
 +
*Trigger Time =  -2 (the number of days before check-in you want to sent the code or link)
 +
*Trigger Window = 2
  
*Trigger Event = After Booking
+
Booking Source:-
*Trigger Time =  immediately
 
*Trigger Window = 365
 
 
*Booking Source = All
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Booking Status = All but not cancelled
*Group bookings" =  Trigger all on master
 
*Template Variable = [GUESTCUSTOMQ1] equals ticked (or) not ticked
 
  
Booking info tab :  
+
Booking Conditions:-
*Info Code = LATECHECKIN
+
*Group bookings =  Trigger all on master
 +
*Invoice Balance = Zero
 +
 
 +
Info codes :-
 +
*Any Booking Info Code = STRIPEAUTHORIZE
 +
 
 +
'''Messaging tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
 +
 
 +
*Send Message = Booking API/Smart Email
 +
 
 +
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 +
 
 +
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 +
 
 +
*Subject - enter the subject for your Guests - Your access code (your text)
 +
 
 +
*Plain text box - will send to channels using Message API
 +
 
 +
Message Text :- enter the text you wish to send to your guests. This can include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used [[Template_Variables| see here]]
 +
 
 +
*HTML box - Email will be sent
 +
 
 +
Email Text :- Enter the text you wish to send to your guests this can include URLs. Include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used [[Template_Variables| see here]]
 +
 
 
</div>
 
</div>
 
</div>
 
</div>
 
===Add invoice items to a booking ===
 
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Add a fee to all bookings from a channel====
+
 
 +
====Send Email to all current guest  (Check-in) ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
+
'''Trigger tab:'''
*Trigger Event = After Booking
+
 
 +
Time:
 +
*Trigger Event = Check-in
 
*Trigger Time = Immediate
 
*Trigger Time = Immediate
*Booking Source = Expedia (for example)
+
*Trigger Window = 14(the max number of days your guests can stay)
  
Invoice tab:
+
Booking Source:
*Type = Amount
+
*Booking Source = All
*Description = Cleaning fee (for example)
 
*Amount = 50 (for example - the amount of your cleaning fee)
 
*per = Room
 
*Period = one time
 
*VAT = 19% (for example - enter the VAT amount if applicable)
 
  
The fee will be added the next time the auto actions run.
+
Booking Conditions:
</div>
+
*Group bookings =  Trigger all on master
</div>
+
*Booking Status = All but not cancelled
  
===Payments/Pending Payments===
+
Info Codes:
 +
*Any Booking Info Code = CHECKIN
 +
*Exclude Booking Info Code = CHECKOUT
  
<div class="mw-collapsible mw-collapsed">
+
'''Messaging tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
<div  class="headline-collapse" >
 
====Add a pending payment====
 
</div>
 
<div class="mw-collapsible-content">
 
Trigger tab:
 
*Trigger Event = After Booking or Before Check-in
 
*Trigger Time = set the time you want to collect the payment
 
*Booking Source =All (for example, you can also set different rules for different channels)
 
  
Booking Info tab: Optional
+
*Send Message = Booking API/Smart Email
Add a booking info tab for information and reporting
+
*Flag Text = PendingPayment (for example)
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 
  
Booking tab: Optional
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
*Flag Text = Pending payment added (for example)
 
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 
  
Invoice tab:
+
*Subject - enter the subject for your Guests
*Payment Type = select on what the payment is calculated (Percent of Balance due)
 
*Description = the text you will see in the "Charges and Payments" tab
 
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
 
*Amount = enter the amount or percentage you want to collect
 
*Payment Rule = use auto or manual  - if you have set up payment rules in SETTINGS->GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here
 
*Payment Due = Set when the payment is due
 
  
 +
*Plain text box - will send to channels using Message API
  
Create a Payment Rule to collect a payments when bookings are not cancelled.  
+
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
  
Go to Settings > Payments > Payment Rules
+
*HTML box - Email will be sent
  
Payment Rule :
+
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
  
Name = Enter your title - Not Cancelled (for example)
 
Action = Auto
 
  
Payment Trigger :
+
<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
 +
</div>
 +
</div>
  
*Booking Status = All not cancelled
+
<div class="mw-collapsible mw-collapsed">
*Any Booking Info Code = optional
+
<div  class="headline-collapse" >
*All Booking Info Codes = optional
 
*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 
  
Payment Action :
+
====Send invoice after check-out - PDF attachment - ''Select from the predefined template'' ====
 +
</div>
 +
<div class="mw-collapsible-content">
  
*Capture = Yes - immediately charged (Capture=Yes)
+
You can send Invoice as an attachment to your Guests.
*Add info code on success = add a Booking Info item to the booking on success
 
*Add info code on failure = add a Booking Info item to the booking on failure
 
  
</div>
+
Setup your Invoice go to {{#fas:cog}} (SETTINGS)  GUEST MANAGEMENT -> INVOICING
</div>
 
  
<div class="mw-collapsible mw-collapsed">
+
'''Trigger tab:'''
<div  class="headline-collapse" >
 
  
====Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)====
+
Time:
</div>
+
*Trigger Event = Checkout
<div class="mw-collapsible-content">
+
*Trigger Time = Immediate +8hrs
 +
*Trigger Window = 1 day
  
''''Create a Payment Rule  (Optional)''''
+
Booking Source:
 +
*Booking Source = All (or select the appropriate channel/Direct)
  
Standard payment rules in the system are Auto & Manual, you can create additional rules for the collection of outstanding payments, you can control the collection of payments if the booking status is changed, for example the booking is cancelled before the final payment is due to be collected.
+
Booking Conditions:
 +
*Group bookings =  Trigger all on master
 +
*Booking Status = Confirmed
  
Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
+
Info Codes:
 +
*Any Booking Info Code = CHECKOUT
  
Create a Payment Rule to collect payments if bookings are not cancelled.
+
'''Messaging tab:'''
  
Click '''Create New Payment Rule''' :
+
*Send Email = Guest email - (or one of the other options)
  
Payment Rule:
+
*Attachment = Invoice Template 1
*Name = Enter your title - Not Cancelled (for example)
 
*Action = Auto
 
  
Payment Trigger :
+
*Subject - enter the subject for your Guests
*Booking Status = All not cancelled
+
 
*Any Booking Info Code (optional)
+
*Plain text box - will send to channels using Message API
*All Booking Info Codes (optional)
 
*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 
  
Payment Action :
+
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
*Funding Source = Guest card only
 
*Payment value adjustment = Limit to group booking balance
 
*Capture = Yes - immediately charged (Capture=Yes)
 
*Add info code on success = add a Booking Info item to the booking on success
 
*Add info code on failure = add a Booking Info item to the booking on failure
 
  
Prevent Auto Payment :
+
*HTML box - Email will be sent
*Prevent payment if booking status = Cancelled
 
*Prevent payment after check-out (days) = 7 (default)
 
*Prevent payment action = Set Manual
 
  
 +
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
  
'''Create Auto Actions '''
+
<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkout to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
  
Collect the outstanding balance for bookings created via your booking page.  
+
If you send Emails with pdf attachment (invoice, booking template) to Alias-Email addresses created by channels the channel might block the attachment so it is not delivered to the guest. Ask your channel about their policy regarding this.
  
Go to {{#fas:cog}} (SETTINGS)  GUEST MANAGEMENT > AUTO ACTIONS and click '''Create New Action''' to create them.
+
Other files can not be attached. We recommend you use a link to a file you upload to your web site.
 +
</div>
 +
</div>
  
'''Collect outstanding balance for direct bookings'''
+
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
  
Trigger tab:
+
====Send Email with Booking Registration Form - PDF attachment====
*Time
+
</div>
**Trigger Event = Checkin
+
<div class="mw-collapsible-content">
**Trigger Time = -3 days (set the time you want to collect the payment)
+
 
**Time Window = 3 days (set this to the same number (positive) as Trigger time.
+
You can send Booking Template attachments to your Guests.
 +
 
 +
Setup your Booking Template, go to {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT -> BOOKING TEMPLATES
 +
 
 +
'''Trigger tab:'''
  
*Booking Source
+
Time:
**Booking Source = Direct. You can have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
+
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
  
*Booking Conditions
+
Booking Source:
**Group Booking Trigger = Trigger only Master
+
*Booking Source = All (or select the appropriate channel/Direct)
**Status = All not cancelled
 
**Invoice Balance= Not Zero (can be used to refine the auto action being triggered)
 
  
Booking tab: Optional
+
Booking Conditions:
*Flag Text = Pending payment added (for example)
+
*Group bookings = Trigger all on master
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
+
*Booking Status = All but not cancelled
  
Booking Info tab: Optional, for information and reporting
+
'''Messaging tab:'''
*Booking Info Code = BALANCE (for example enter the value - use one word only)
 
*Booking Info Text = Enter the description/text to show in for the Booking Info Code.
 
  
Invoice tab:
+
*Send Message = Guest API/Smart Email (or one of the other options)
  
<div class="warning">{{#fas:exclamation-triangle}} ONLY use Payment Type =‘ Percent of Group balance due’ if you selected Trigger tab > Booking Conditions > Group Booking Trigger = Trigger Only  Master.</div>
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
  
*Add a Pending Payment to the booking
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
**Payment Type = Percent of Group Balance due (select on what the payment is calculated)
+
 
**Description = the text you will see in the "Charges and Payments" tab
+
*Attachment = Select Booking Template from the drop down list.
**Status = if you use the status function add the status you want to apply to the pending payment (optional)
+
 
**Amount = 100 (this will be 100% of the outstanding group balance)
+
*Subject - enter the subject for your Guests
**Payment Rule = Not Cancelled - See Step 4 above (if you have set up payment rules in SETTINGS->PAYMENTS ->PAYMENT RULES they will be available here)
+
 
**Payment Due = Trigger date
+
*Plain text box - will send to channels using Message API
**Payment time = set the time to collect payment
+
 
**Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
+
Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used [[Template_Variables| see here]]
 +
 
 +
*HTML box - Email will be sent
 +
 
 +
Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
 +
 
 +
<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkout to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
 +
 
 +
If you send Emails with pdf attachment (invoice, booking template) to Alias-Email addresses created by channels the channel might block the attachment so it is not delivered to the guest. Ask your channel about their policy regarding this.
  
 +
Other files can not be attached. We recommend you use a link to a file you upload to your web site.
 
</div>
 
</div>
 
</div>
 
</div>
Line 1,270: Line 1,595:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
===='Capture' a Security Deposit when Credit card is collected at time of booking. ====
+
====Send Email after the cleaner has cleaned the room====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
Trigger tab:
+
To send an automated Email to the guest then they can check you/the cleaner have to add a unit status to the room when it is ready.  In this example we used the unit status clean
*Trigger Event = After Booking
+
 
*Trigger Time = immediate
+
'''Trigger tab:'''
*Booking Source =All (for example, you can also set different rules for different channels)
 
  
Invoice tab:
+
Time:
*Payment Type = Fixed amount
+
*Trigger Event = Checkin
*Description = Security Deposit (the text you will see in the "Charges and Payments" tab)
+
*Trigger Time = Immediate
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
+
*Trigger Window = 1
*Amount = 100 (balance is full price so 100% of the balance)
 
*Payment Rule = Security Deposit (Create a Payment Rule, see below)
 
*Payment Due = check in
 
  
 +
Booking Source:
 +
*Booking Source = All
  
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> Automatic collection is only available for customer who use [[Stripe]].
+
Booking Conditions
 +
*Group bookings = Trigger all on master
 +
*Booking Status = All but not cancelled
 +
 
 +
Booking Fields:
 +
*Template Variable = [UNITSTATUS1] Contains = clean
  
Create a Payment Rule to 'Capture' a payment only. Captured payments will only be valid for 7 days, then it will expire, if the booking is for a longer period, then you can create a second Capture, you will need to create another auto action for this.
+
'''Messaging tab: '''
 +
*Send Email = Guest API/Smart Email (or one of the other options)
  
Go to Settings  >  Payments  > Payment Rules
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
  
Payment Rule :
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
*Name = Enter your title - Security Deposit (for example)
 
*Action = Auto
 
  
Payment Trigger :
+
*Subject - enter the subject for your Guests
*Booking Status = select from the drop down list
 
*Any Booking Info Code = optional
 
*All Booking Info Codes = optional
 
*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 
  
Payment Action :
+
*Plain text box - will send to channels using Message API
*Capture = Yes/No - immediately charged (Capture=Yes), if you want to make sure that the amount is available for later capture (Capture=No)
 
*Add info code on success = add a Booking Info item to the booking on success
 
*Add info code on failure = add a Booking Info item to the booking on failure
 
</div>
 
</div>
 
  
<div class="mw-collapsible mw-collapsed">
+
Message Text :- enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
<div  class="headline-collapse" >
+
 
====Apply an info code and and/or icon when a payment was made====
+
*HTML box - Email will be sent
</div>
+
 
<div class="mw-collapsible-content">
+
Email Text :- It is possible to use the same details as in the Plain Text box above. Template variables can be used [[Template_Variables| see here]]
Trigger tab:
+
 
*Trigger Event = After Booking
+
*Attachment :- if you want to send a Booking/Invoice template you can select from the drop down list.
*Trigger Time = Immediate
 
*Trigger Window = 365
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Invoice Balance = Any Payment made
 
  
Booking Info tab:
+
Other files can not be attached. We recommend you use a link to a file you upload to your web site.
*Execution = One time only
 
*Info Code = Enter the preset code for the icon or info code which you have created in SETTINGS->ACCOUNT->PREFERENCES.
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Assign invoice numbers====
+
 
 +
====Send Email to your guest - Upselling additional nights - nights available after checkout ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
 
*Trigger Event = Check-out
 
*Trigger Time = Immediate
 
*Any Booking Info Code = CHECKOUT (optional only if you use the check-out function, if not leave blank)
 
  
Invoice tab:
+
To send an automated Email to the guest confirming that it is possible to extend their stay.
*Assign Invoice Number = yes
+
 
</div>
+
This example uses fixed values that you have entered into {{#fas:cog}} (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.
</div>
 
  
<div class="mw-collapsible mw-collapsed">
+
'''Trigger Tab :'''
<div  class="headline-collapse" >
+
 
====Using Pending Payments as a Payment Reminder====
+
Time:
</div>
+
*Trigger Event = Checkin (depending on when you want to notify the guest)
<div class="mw-collapsible-content">
+
*Trigger Time = -2 days (depending on when you want to notify the guest, in this example 2 days before arrival)
Trigger tab:
+
*Trigger Window = 2
*Trigger Event = After Booking or Before Check-in
+
 
*Trigger Time = set the time you want to add the pending payment to the booking
+
Booking Source:
*Booking Source =All (for example, you can also set different rules for different channels)
+
*Booking Source = All  
  
Booking Info tab:
+
Booking Conditions:
*Optional, add a booking info tab for information and reporting
+
*Group bookings =  Trigger all on master
 +
*Booking Status = All but not cancelled
  
Booking tab: Optional
+
Booking Fields:
*Flag Text = PaymentDue1 (for example), set multiple if multiple payments are required.
+
*Template Variables = [IFBETWEEN:[TURNOVERDAYS]:0:3:yes|no|no] equal yes
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 
  
Invoice tab:
+
This template variable tests if there is 3 days between the guest booking and the next booking.
*Payment Type = select on what the payment is calculated (Percent of Balance due)
 
*Description = the text you will see in the "Charges and Payments" tab
 
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
 
*Amount = enter the amount or percentage you want to collect
 
*Payment Rule = Manual  - if you have set up payment rules in SETTINGS->GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here
 
*Payment Due = Set when the payment is due
 
  
The Pending Payment Report is available in Bookings > Pending Payments. This report can be used to see outstanding pending payments, this can be used to see all outstanding payments, when payment gateways other than Stripe are used, the Pending Payments report can be used to see outstanding payments and a checklist for bank transfers.
+
'''Message tab:'''
  
</div>
+
For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
</div>
 
  
===Booking Flags/Colours===
+
*Send Message = Booking API/Smart Email
  
<div class="mw-collapsible mw-collapsed">
+
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
<div  class="headline-collapse" >
+
 
====Apply a flag when a booking is cancelled====
+
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
</div>
+
 
<div class="mw-collapsible-content">
+
*Email Subject - enter the subject for your Guests
Trigger tab
+
 
*Trigger Event = After Booking
+
*Plain text box - will send to channels using Message API, enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
*Trigger Time = 1 Hour
+
 
*Trigger Window = 365 days
+
[IF<=:[TURNOVERDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [TURNOVERDAYS] extra night(s)|].
*Booking Status = Cancelled
+
 +
We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.
 +
 
 +
 
 +
*HTML box - Email will be sent, enter the text you wish to send to your guests. Template variables can be used [[Template_Variables| see here]]
 +
 
 +
[IF<=:[TURNOVERDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [TURNOVERDAYS] extra night(s)|].
 +
 +
We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.
 +
 
 +
'''Booking Info Tab : Optional '''
 +
*Booking info code = EXTRANIGHTS
 +
*Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night
  
Booking tab:
 
*Execution = One time only
 
*Booking Status = No Change
 
*Flag text = (enter the text you require)
 
*Flag Colour = Set as required
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Apply a flag for a bookings from a channel which have breakfast included====
+
 
 +
====Send Email to your guest - Upselling additional nights - nights available before checkin ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
 
*Trigger Event = After Booking
 
*Trigger Time = Immediate
 
*Booking Source = Booking.com (for example)
 
*Booking Field Contains  - select "API Message" in the next field enter: meal_plan=Breakfast  (or Extra Breakfast - use the text the channel uses)
 
  
Booking tab:
+
To send an automated Email to the guest confirming that it is possible to extend their stay.
*Execution = One time only
+
 
*Flag Text = The text you want to display
+
This example uses fixed values that you have entered into {{#fas:cog}} (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.
*Flag Colour - choose the flag colour
+
 
 +
'''Trigger Tab :-'''
  
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
+
Time:
</div>
+
*Trigger Event = Checkin (depending on when you want to notify the guest)
</div>
+
*Trigger Time = -2 days (depending on when you want to notify the guest, in this example 2 days before arrival)
 +
*Trigger Window = 2
  
<div class="mw-collapsible mw-collapsed">
+
Booking Source:
<div  class="headline-collapse" >
+
*Booking Source = All
====Apply a flag when deposit was made prior to Check-in====
 
</div>
 
<div class="mw-collapsible-content">
 
Trigger tab:
 
  
*Trigger Event = Check-in
+
Booking Conditions:
*Trigger Time = -365 (for example : must be a negative value and the same as the value in Trigger window)
+
*Group bookings = Trigger all on master
*Trigger Window = 365
 
*Booking Source = All
 
 
*Booking Status = All but not cancelled
 
*Booking Status = All but not cancelled
*Invoice Balance = Any Payment made
 
  
Message tab:  
+
Booking Fields:
 +
*Template Variables = [IFBETWEEN:[VACANTDAYS]:0:3:yes|no|no] equal yes
  
*Send Email : select appropriate option
+
This template variable tests if there is upto 3 days from previous checkout to check in of current booking.
*Enter : Subject and Email content
 
  
Booking tab: (optional)
+
'''Messaging tab :- '''
 +
*Send Message = Guest API/Smart Email
 +
 
 +
If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
 +
 
 +
If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.
 +
 
 +
*Subject = Enter the appropriate details
 +
 
 +
*Plain Text Box = Your text, using the template variables to modify the specific text in the booking.
 +
 
 +
[IF<=:[VACANTDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [VACANTDAYS] extra night(s)|].
 +
 +
We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.
  
*Execution = One time only
+
*HTML Box
*Flag Text = The text you want to display
 
*Flag Colour - choose the flag colour
 
  
Booking info tab : (optional)
+
[IF<=:[VACANTDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [VACANTDAYS] extra night(s)|].
 +
 +
We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.
  
*Booking Info Code : DEPOSITPAID (for example)
+
'''Booking Info Tab :- Optional'''
*Booking Info Text : additional text if required.
+
*Booking info code = EXTRANIGHTS,
 +
*Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night
  
Setting details with the Booking tab and Booking info tab allows you to trigger additional (follow on) Auto Actions and Reports.
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Apply a flag when booking is fully paid====
+
 
 +
====Send Email to your guest - Offering Early Checkin ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab:
 
*Trigger Event = After Booking
 
*Trigger Time = Immediate
 
*Trigger Window = 365
 
*Booking Source = All
 
*Booking Status = All not cancelled
 
*Invoice Balance = ZERO
 
  
Booking tab:
+
To send an automated Email to the guest confirming that it is possible to have an Early Checkin as room is available the day of before arrival.
*Execution = One time only
+
 
*Flag Text = The text you want to display
+
This example uses fixed values that you have entered into {{#fas:cog}} (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.
*Flag Colour - choose the flag colour
+
 
 +
Trigger Tab :-
 +
*Trigger Event = Checkin (depending on when you want to notify the guest)
 +
*Trigger Time = -2 days (depending on when you want to notify the guest, in this example 2 days before arrival)
 +
*Trigger Window = 2
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Group bookings =  Trigger all on master
 +
*Template Variables = [IF>:[VACANTDAYS]:1:yes|no] equal yes
 +
 
 +
This template variable tests if there is 1 day between the guest booking and the next booking.
 +
 
 +
Message tab :-
 +
*Send Email = Guest API/Smart Email (or one of the other options)
 +
*EMail Subject = Enter the appropriate details
 +
*Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)
 +
 
 +
Dear, [GUESTNAME],
 +
 
 +
We are very happy to offer you 'Early Check-in' at [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK].
 +
 
 +
If you would like checkin early for your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EARLYARRIVAL’ for the special Price.
 +
Best regards,
 +
 
 +
[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME]
 +
[PROPERTYNAME] 
 +
[PROPERTYADDRESS],
 +
[PROPERTYCITY],
 +
[PROPERTYPOSTCODE],
 +
[PROPERTYSTATE],
 +
[PROPERTYCOUNTRY].
 +
 
 +
Email :-[PROPERTYEMAIL]
 +
Website :- [PROPERTYWEB]
 +
 
 +
Booking Info Tab :- Optional
 +
*Booking info code = EARLYARRIVAL,
 +
*Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] Early Checkin
 +
 
 
</div>
 
</div>
 
</div>
 
</div>
Line 1,473: Line 1,816:
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
====Apply a flag/colour for a booking coming from a certain channel====
+
====Send Email to your guest - Offering Late Checkout ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
Trigger tab:
+
To send an automated Email to the guest confirming that it is possible to have a Late Checkout  as room is available the day of departure.
*Trigger Event = After Booking
 
*Trigger Time = Immediate
 
*Booking Source = Booking.com (for example)
 
  
Booking tab:
+
This example uses fixed values that you have entered into {{#fas:cog}} (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.
*Execution = One time only
 
*Flag Text = The text you want to display
 
*Flag Colour - choose the flag colour
 
  
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the email.
+
Trigger Tab :-
</div>
+
*Trigger Event = Checkout
</div>
+
*Trigger Time = -1 days (depending on when you want to notify the guest, in this example 2 days before arrival)
 +
*Trigger Window = 1
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Group bookings =  Trigger all on master
 +
*Template Variables = [IF>:[TURNOVERDAYS]:1:yes|no] equal yes
 +
 
 +
This template variable tests if there is 1 day between the guest booking and the next booking.
 +
 
 +
Message tab :-
 +
*Send Email = Guest API/Smart Email (or one of the other options)
 +
*EMail Subject = Enter the appropriate details
 +
*Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)
 +
 
 +
Dear, [GUESTNAME],
  
<div class="mw-collapsible mw-collapsed">
+
We are very happy to offer you 'Late Check-out' at [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK].
<div  class="headline-collapse" >
+
 
====Apply a flag when a payment was made====
+
If you would like a late checkout, then please send an email to our Reservations team [PROPERTYEMAIL] confirming you would like the Late Checkout, provide your Booking Reservation Number [BOOKID] and Offer ‘LATECHECKOUT’ for the special Price.
</div>
+
 
<div class="mw-collapsible-content">
+
Best regards,
<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span>  Also see Example : " Apply a flag when deposit was made prior to Check-in AND/OR Apply a flag when booking is fully paid".
+
 
 +
[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME]
 +
[PROPERTYNAME] 
 +
[PROPERTYADDRESS],
 +
[PROPERTYCITY],
 +
[PROPERTYPOSTCODE],
 +
[PROPERTYSTATE],
 +
[PROPERTYCOUNTRY].
 +
 
 +
Email :-[PROPERTYEMAIL]
 +
Website :- [PROPERTYWEB]
  
Trigger tab:
+
Booking Info Tab :- Optional
*Trigger Event = After Booking
+
*Booking info code = LATCHECKOUT,
*Trigger Time = Immediate
+
*Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] Late Checkout
*Trigger Window = 365
 
*Booking Source = All
 
*Booking Status = All not cancelled
 
*Invoice Balance = Any Payment made
 
  
Booking tab:
 
*Execution = One time only
 
*Flag Text = The text you want to display
 
*Flag Colour - choose the flag colour
 
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >  
+
<div  class="headline-collapse" >
====Apply a flag when a payment FAILS at Stripe====
+
 
 +
====Send Email to your guest - Offering Late Checkout Only on a Sunday when there is no new arrival ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Trigger tab:
 
*Trigger Event = After Booking
 
*Trigger Time = Immediate
 
*Trigger Window = 365
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Booking Info Code = STRIPEFAIL
 
  
Booking tab:
+
To send an automated Email to the guest confirming that it is possible to have a Late checkout on Sundays as the room is available on the day of departure.
*Execution = One time only
+
 
*Flag Text = Stripe Payment Failed
+
This auto action will create a new booking for the date of departure, closing the calendar to any other bookings.
*Flag Colour - choose the flag colour
+
 
</div>
+
The URL link in the message tab, will send the guest to your guest booking page with set conditions, the leaving date of the existing booking, the room id of the existing booking and the Offer you have created for the LateCheckout.
</div>
+
 
 +
This example uses fixed values that you have entered into {{#fas:cog}} (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.
 +
 
 +
'''Step 1: ''' Create a new offer in {{#fas:cog}} (SETTINGS) > PROPERTIES > OFFERS
  
<div class="mw-collapsible mw-collapsed">
+
*Name = Latecheckout
<div  class="headline-collapse" >
+
*Enable = Only if Available
====Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe====
+
*Booking Type = Confirmed with Deposit 2 - via payment gateway
</div>
 
<div class="mw-collapsible-content">
 
  
Go to Settings > Channel Manager > Preferences and set Auto report failed cards = Yes
+
'''Step 2:''' Create a Rate or Daily Price, PRICES
 
Trigger tab:
 
*Trigger Event = After Booking
 
*Trigger Time = Immediate
 
*Trigger Window = 365
 
*Booking Source = All
 
*Booking Status = All but not cancelled
 
*Booking Info Code = BOOKINGCOMCARD
 
  
Booking tab:
+
*Guests = Max Occupancy
*Execution = One time only
+
*Max Stay = 1
*Flag Text = Failed CC reported to Booking.com
+
*Offer = select the offer number as created in the above step.
*Flag Colour - choose the flag colour
 
</div>
 
</div>
 
  
===Status changes===
+
If you are using Rates, select 'Rate allowed' = Sunday, untick all the other days.
<div class="mw-collapsible mw-collapsed">
+
Channel Tab, untick all channels, leave only 'beds24.com' for your booking page.
<div  class="headline-collapse" >
 
==== Change the status of all "Request" bookings to "Cancelled" after three days ====
 
</div>
 
<div class="mw-collapsible-content">
 
Trigger tab
 
*Trigger Event = After Booking
 
*Trigger Time = 3 days
 
*Booking Status = Request
 
  
Booking tab:
+
If using Daily Prices, then go to Calendar, and set the price and date range, then only Sunday, untick all the other days.
*Execution = One time only
+
Enable list, untick all channels, leave only 'beds24.com' for your booking page.
*Booking Status = Cancelled
 
</div>
 
</div>
 
  
<div class="mw-collapsible mw-collapsed">
+
'''Step 3: ''' Create the custom question for the booking id
<div  class="headline-collapse" >
 
  
==== Change the status of all bookings which have been imported from Ical to "Request" ====
+
Go to {{#fas:cog}} (SETTINGS) > PROPERTIES > BOOKING QUESTIONS > CUSTOM QUESTIONS and create a question
</div>
+
*Question = Booking Id
<div class="mw-collapsible-content">
+
*Single Line field
Trigger tab:
+
*Optional
*Trigger Event = After Booking
 
*Trigger Time = Immediate
 
*Booking Source = Ical Import (1, 2, 3)
 
  
Booking tab:
+
'''Step 4: ''' Create the Auto Action
*Execution = One time only
+
 
*Booking Status = Request
+
Trigger Tab :-
 +
*Trigger Event = Checkout
 +
*Trigger Time = -1 days (depending on when you want to notify the guest, in this example 2 days before arrival)
 +
*Trigger Window = 1
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Between Booking and Check in = 2 and 999 (to stop the auto action triggering on the new booking)
 +
 
 +
*Group bookings =  Trigger all on master
 +
 
 +
*Template Variables = [IF=:[LEAVINGDAY:{%a}]:Sun:[IF>=^[TURNOVERDAYS]^1^yes~no]|] equal yes
 +
 
 +
This template variable tests if the departure day is a Sunday and there is at least 1 day between the existing guest booking and the next booking.
 +
 
 +
Message tab :-
 +
*Send Email = Guest API/Smart Email (or one of the other options)
 +
*EMail Subject = Enter the appropriate details
 +
*Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)
 +
 
 +
Dear, [GUESTNAME],
 +
 
 +
We are very happy to offer you 'Late Check-out' at [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK].
 +
 
 +
If you would like a late checkout, please use this link to make the booking and payment.
 +
 
 +
https://beds24.com/booking2.php?propid=[PROPERTYID]&checkin_hide=[LEAVINGDAYYYYY-MM-DD]&br5-[ROOMID]=Book
 +
 
 +
<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> The details in the URL, will direct the guest to make a new booking in the existing room with the check-in date = leaving date and for Offer 7 &br-7 (offer created in Step 1 above)
 +
 
 +
Enter your Booking Reservation Number [BOOKID] into the Booking id box on the booking page.
 +
Best regards,
 +
 
 +
[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME]
 +
 +
Email :-[PROPERTYEMAIL] 
 +
Website :- [PROPERTYWEB]
 +
 
 +
Booking Info Tab :- Optional
 +
*Booking info code = LATCHECKOUT,
 +
*Booking Info Description = Upsell email sent [CURRENTDATE]: Late Checkout
  
Booking changes are applied before the mail is sent.
 
 
</div>
 
</div>
 
</div>
 
</div>
 
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
 
<div  class="headline-collapse" >
 
<div  class="headline-collapse" >
  
==== Change Room Unit Status when guest checks out ====
+
====Send Email to your guest - On a Wednesday (Cleaner is due/Rubbish Collection is due) ====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
Trigger tab
 
*Trigger Event = Check-out
 
*Trigger Time = Immediate
 
*Trigger Window = 1 day
 
*Booking Status = All but not cancelled
 
*Any Booking Info Code = CHECKOUT
 
  
Booking tab:
+
To send an automated Email to the guest reminding them that there is an event on a specific day of the week, for instance, the cleaner is due on Wednesday mornings, or the bin collection is due on Thursday mornings.
*Execution = One time only
+
 
*Change Room Unit Status = Select the option
+
You will need to check for the day of the week. If the booking is for more than 1 week, you will need multiple auto actions as an email will only be sent once, it is not possible to trigger multiple times.
 +
 
 +
'''Step 1: ''' Create the Auto Action
 +
 
 +
Trigger Tab :-
 +
*Trigger Event = Checkin
 +
*Trigger Time = Immediate
 +
*Trigger Window = 8 days
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
 
 +
*Template Variables = [IF=:[CURRENTDATE:{%u}]:3:yes|no] equal yes
 +
 
 +
%u ISO-8601 numeric representation of the day of the week 1 (for Monday) through 7 (for Sunday)
 +
 
 +
This template variable tests if the current day is a Wednesday.
 +
 
 +
Message tab :-
 +
*Send Email = Guest API/Smart Email (or one of the other options)
 +
*EMail Subject = Enter the appropriate details
 +
*Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)
 +
 
 +
Dear, [GUESTNAME],
 +
 
 +
Hope you are enjoying your holiday at [PROPERTYNAME].
 +
 
 +
We would like to remind you that the cleaner is due to visit you on Thursday morning between 10am and 12am. 
 +
 
 +
Best regards,
 +
 
 +
[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME]
 +
 +
Email :-[PROPERTYEMAIL] 
 +
Website :- [PROPERTYWEB]
 +
 
 +
Booking Info Tab :- Optional
 +
*Booking Info code = CLEANWED1
 +
*Booking Info text = Reminder that cleaning is due on the first Thursday of their stay.
 +
 
 +
This can be used to trigger the next auto action if the duration of their holiday is more than 1 week. Include the Booking Info code in the Trigger tab of the next auto action.
  
It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
 
 
</div>
 
</div>
 
</div>
 
</div>
  
===API/Webhook===
+
===Send an email to the Owner/Internal email address ===
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
 
<div  class="headline-collapse" >  
 
<div  class="headline-collapse" >  
====Use API/Webhook to write to the field 'Message'====
+
====Send an email to the Owner/Internal email address when a payment FAILS at Stripe====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE
  
You can use a webhook in conjunction with the API JSON function '''setBooking''' to write to any field in the booking. First you have to configure access to the API:
+
Messaging tab:
 
+
*Send Message = Internal
You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
+
*Internal Email Address = enter the email address to receive the notification
'''API key:'''
+
*Subject = Failed Stripe Payment
*SETTINGS -> ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
+
*HTML Box = Enter the text to be sent, you can use template variables in this message, for example  
*API Key = my_very_secret_api_key
 
*API Key Access = allow any IP
 
*IP Whitelist = [leave empty]
 
*Allow Writes = Yes
 
*Property Access = Owned by this account only
 
*'''Property key:'''
 
*Settings  >  Properties  > Access > propKey = secret_key_for_prop_XXXXXX
 
 
 
Set the triggers you need, for example:
 
  
Booking Field Contains: Message = XXX
+
[BOOKID] - booking reference number
 +
[GUESTNAMES] - name of all guests in the booking on the "summary" tab of the booking
 +
[FIRSTNIGHT]
 +
[LASTNIGHT]
  
Set the webhook like this:
+
Booking tab: (optional)
 +
*Execution = One time only
 +
*Flag Text = Stripe Payment Failed
 +
*Flag Colour - choose the flag colour
 +
</div>
 +
</div>
  
* URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
+
<div class="mw-collapsible mw-collapsed">
* Custom Header = [leave empty]
+
<div class="headline-collapse" >
  
Body Data:
+
====Send an email to the Owner/Internal email address when a guest completes a Payment Authorisation at Stripe====
:{
+
</div>
::"authentication":
+
<div class="mw-collapsible-content">
::{
+
:::"apiKey": "my_very_secret_api_key",
+
Trigger tab:
:::"propKey": "secret_key_for_prop_XXXXXX"
+
*Trigger Event = Booking
::},
+
*Trigger Time = Immediate
::"bookId": "[BOOKID]",
+
*Trigger Window = 365
::"message": "[MESSAGE] - Append this message"
+
*Booking Source = All
:}
+
*Booking Status = All but not cancelled
 +
*Booking Info Code = STRIPEAUTHORIZE
 +
 
 +
Messaging tab:
 +
*Send Message = Internal
 +
*Internal Email Address = enter the email address to receive the notification
 +
*Subject = Stripe Payment Authorisation
 +
*HTML Box = Enter the text to be sent, you can use template variables in this message, for example
 +
 
 +
[BOOKID] - booking reference number
 +
[GUESTNAMES] - name of all guests in the booking on the "summary" tab of the booking
 +
[FIRSTNIGHT]
 +
[LASTNIGHT]
 +
 
 +
Booking tab: (optional)
 +
*Execution = One time only
 +
*Flag Text = Stripe Authorised
 +
*Flag Colour - choose the flag colour
 
</div>
 
</div>
 
</div>
 
</div>
  
 
<div class="mw-collapsible mw-collapsed">
 
<div class="mw-collapsible mw-collapsed">
<div class="headline-collapse" >  
+
<div class="headline-collapse" >
====Use API/Webhook to write the value of the 'commission' field to a new invoice item====
+
 
 +
====Send an email to the Owner/Internal email address for a new booking====
 
</div>
 
</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
You can create a new invoice item that contains the price of the channel's commission as a negative value to subtract it from the room price. You use the API JSON function '''setBooking''' for this. First you need to configure access to the API:
+
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
 
 +
Messaging tab:
 +
*Send Message = Internal
 +
*Internal Email Address = enter the email address to receive the notification
 +
*Subject = New Booking
 +
*HTML Box = Enter the text to be sent, you can use template variables in this message, for example
  
You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
+
[BOOKID] - booking reference number
'''API key:'''
+
[GUESTNAMES] - name of all guests in the booking on the "summary" tab of the booking
*SETTINGS -> ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
+
[FIRSTNIGHT]
*API Key = my_very_secret_api_key
+
[LASTNIGHT]
*API Key Access = allow any IP
 
*IP Whitelist = [leave empty]
 
*Allow Writes = Yes
 
*Property Access = Owned by this account only
 
*'''Property key:'''
 
*Settings  >  Properties  > Access > propKey = secret_key_for_prop_XXXXXX
 
  
Set the triggers you need, for example:
+
</div>
 +
</div>
  
Booking Source = Booking.com
+
===Booking Info Codes===
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Add CHECKIN Booking info code to bookings ====
 +
</div>
 +
<div class="mw-collapsible-content">
  
Set the webhook like this:
+
If you need to use the Booking info code CHECKIN/CHECKOUT for reporting/other auto actions, you can set the Booking info code rather than use the Current guest module in the dashboard.
  
*URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
+
Trigger tab:
*Custom Header = [leave empty]
+
*Trigger Event = Check-in
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Group bookings = Trigger all on master
  
*Body Data =
+
Booking Info tab:
:{
+
*Booking Info Code = CHECKIN
::"authentication":
+
*Booking Info Text = Auto Checkin
::{
+
</div>
:::"apiKey": "my_very_secret_api_key",
+
</div>
:::"propKey": "secret_key_for_prop_XXXXXX"
+
 
::},
+
<div class="mw-collapsible mw-collapsed">
::"bookId": "[BOOKID]",
+
<div class="headline-collapse" >
::"invoice":
+
====Add CHECKOUT Booking info code to bookings ====
::[
+
</div>
:::{
+
<div class="mw-collapsible-content">
::::"description": "Booking.com Commission",
+
 
::::"status": "",
+
If you need to use the Booking info code CHECKIN/CHECKOUT for reporting/other auto actions, you can set the Booking info code rather than use the Current guest module in the dashboard.
::::"qty": "1",
+
 
::::"price": "-[COMMISSIONNUM]",
+
Trigger tab:
::::"vatRate": "7.00",
+
*Trigger Event = Check-out
::::"type": "0",
+
*Trigger Time = Immediate
::::"invoiceeId": ""
+
*Trigger Window = 1 day
:::}
+
*Booking Source = All
::]
+
*Booking Status = All but not cancelled
 +
*Group bookings =  Trigger all on master
 +
 
 +
Booking Info tab:
 +
*Booking Info Code = CHECKOUT
 +
*Booking Info Text = Auto Checkout
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Group check-in - ''Select from predefined templates'' ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
This requires the master booking to be checked-in via the check-in function.
 +
 
 +
'''Trigger tab:'''
 +
 
 +
*Trigger Event = Checkin
 +
*Trigger Time =  immediate
 +
*Time Window = 1 day
 +
 
 +
Booking conditions:
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
 
 +
*Group bookings" =  Trigger all on master if group
 +
*Info Code = CHECKIN
 +
 
 +
'''Booking info tab : '''
 +
 
 +
*Booking Info Code = CHECKIN
 +
*Booking Info Text = Group checked in
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Identify Repeat Guest ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
This requires you to use the Guest database.
 +
 
 +
Trigger tab:
 +
 
 +
*Trigger Event = Booking
 +
*Trigger Time =  immediately
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Group bookings" =  Trigger all on master
 +
*Template Variable = [GUESTSID1] greater than 0
 +
 
 +
Booking info tab :  
 +
*Info Code = REPEAT
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Identify bookings with Custom Question ticked/unticked ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
If you have a custom question with a 'Tick box' for example, they want a late checkin.
 +
 
 +
Setup the custom question in {{#fas:cog}} (SETTINGS)  PROPERTIES -> BOOKING QUESTIONS -> CUSTOM QUESTIONS -> Custom question 1, set with TYPE = Tick Box.
 +
 
 +
Trigger tab:
 +
 
 +
*Trigger Event = Booking
 +
*Trigger Time =  Immediate
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Group bookings" =  Trigger all on master
 +
*Template Variable = [GUESTCUSTOMQ1] equals ticked (or) not ticked
 +
 
 +
Booking info tab :  
 +
*Info Code = LATECHECKIN
 +
</div>
 +
</div>
 +
 
 +
===Add invoice items to a booking ===
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Add a fee to all bookings from a channel====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Booking Source = Expedia (for example)
 +
 
 +
Invoice tab:
 +
*Add Invoice Item = Add new
 +
*Type = Amount
 +
*Description = Cleaning fee (for example) - Template variables can be used.
 +
*Amount = 50 (for example - the amount of your cleaning fee)
 +
*per = Room
 +
*Period = one time
 +
*VAT = 19% (for example - enter the VAT amount if applicable)
 +
 
 +
The fee will be added the next time the auto actions run.
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Add a fee (Penalty) to all bookings with an Outstanding Balance====
 +
 
 +
</div>
 +
<div class="mw-collapsible-content">
 +
You want to add a 2.2% fee to all bookings if there is an outstanding balance 2 days prior to checkin.
 +
 
 +
Trigger tab:
 +
 
 +
Time :
 +
*Trigger Event = Checkin
 +
*Trigger Time = -2 days
 +
*Trigger Window = 2 days
 +
 
 +
Booking Conditions:
 +
*Status = All not Cancelled
 +
*Invoice Balance = Not Zero
 +
 
 +
Invoice tab:
 +
*Type = Amount
 +
*Description = Payment Fee||[INVOICEBALANCE:2.2%]
 +
*Amount = 0 (leave as 0 so the value is set from the calculation in Description field)
 +
*Per = Room
 +
*Period = one time
 +
*VAT = 19% (for example - enter the VAT amount if applicable)
 +
 
 +
The fee will be added the next time the auto actions run.
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Add a negative value to Direct bookings for Stripe Charges====
 +
 
 +
</div>
 +
<div class="mw-collapsible-content">
 +
You want to add the Stripe fee to all Direct bookings to show total value of booking, i.e. if you want to show the booking value. In this example the Stripe charge will be added as a negative figure. 
 +
 
 +
Trigger tab:
 +
 
 +
Time :
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
 +
 
 +
Booking Conditions:
 +
*Status = All not Cancelled
 +
 
 +
Booking Source:
 +
*Booking Source = Direct
 +
 
 +
Invoice tab:
 +
*Type = Amount
 +
*Description = Stripe Fee||[INVOICECHARGESNUM:-3%]
 +
*Amount = 0 (leave as 0 so the value is set from the calculation in the Description field)
 +
*Per = Room
 +
*Period = one time
 +
*VAT = 19% (for example - enter the VAT amount if applicable)
 +
 
 +
The fee/charge will be added the next time the auto actions run.
 +
</div>
 +
</div>
 +
 
 +
===Modify description/values of an existing invoice item in a booking ===
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Update the Description field of a charge/invoice item====
 +
 
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
In some cases Channel bookings have different descriptions for the same charge item - i.e. Cleaning, update the description field in the invoice item so they all match, using the format (findthisinvoicedescription^replacewiththisdescription)
 +
 
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Booking Source = Expedia (for example)
 +
 
 +
Invoice tab:
 +
*Add Invoice Item = Update Only
 +
*Type = Change Description
 +
*Description = Cleaning^Cleaning Service Fee
 +
*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)
 +
 
 +
 
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Update all values of a charge/invoice item====
 +
 
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
You need to change the charges in bookings due to an update in your prices. Tourist Tax (for example), update the description field and value  using the format (findthisinvoicedescription^replacewiththisdescription)
 +
 
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Time Window = 365
 +
*Check In From = Select the first date of the Summer Season
 +
*Check In To = Select the last date of the Summer Season
 +
 
 +
*Booking Source = Expedia (for example)
 +
 
 +
Invoice tab:
 +
*Add Invoice Item = Update Only
 +
*Type = Change All
 +
*Description = Tourist Tax^Tourist Tax - Summer season 2022 (for example)
 +
*Amount = 0.75
 +
*Per = Per Person
 +
*Period = One time
 +
*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)
 +
 
 +
 
 +
</div>
 +
</div>
 +
 
 +
===Payments/Pending Payments===
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Add a pending payment====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking or Booking (but not after Check-in)
 +
*Trigger Time = set the time you want to collect the payment
 +
*Booking Source =All (for example, you can also set different rules for different channels)
 +
*Group Booking Trigger = Trigger only Master (this will trigger on individual bookings and Master booking if a group)
 +
 
 +
Booking Info tab: Optional
 +
Add a booking info tab for information and reporting
 +
*Flag Text = PendingPayment (for example)
 +
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 +
 
 +
Booking tab: Optional
 +
*Booking Info Code = PENDPAY
 +
*Booking Info Text = Pending payment added
 +
 
 +
Invoice tab:
 +
*Payment Type = select on what the payment is calculated (Percent of Balance due OR Group balance if you receive Group bookings)
 +
*Description = the text you will see in the "Charges and Payments" tab
 +
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
 +
*Amount = enter the amount or percentage you want to collect
 +
*Payment Rule = use auto or manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here
 +
*Payment Due = Set when the payment is due
 +
 
 +
 
 +
Create a Payment Rule to collect a payments when bookings are not cancelled.
 +
 
 +
Go to Settings > Payments > Payment Rules
 +
 
 +
Payment Rule :
 +
 
 +
Name = Enter your title - Not Cancelled (for example)
 +
Action = Auto
 +
 
 +
Payment Trigger :
 +
 
 +
*Booking Status = All not cancelled
 +
*Any Booking Info Code = optional
 +
*All Booking Info Codes = optional
 +
*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 +
 
 +
Payment Action :
 +
 
 +
*Capture = Yes - immediately charged (Capture=Yes)
 +
*Add info code on success = add a Booking Info item to the booking on success
 +
*Add info code on failure = add a Booking Info item to the booking on failure
 +
 
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Add a pending payment - Set the Security Deposit value based on the price of the booking, using a calculation ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking or Booking (but not after Check-in)
 +
*Trigger Time = set the time you want to collect the payment
 +
*Booking Source =All (for example, you can also set different rules for different channels)
 +
 
 +
Booking tab: Optional
 +
*Flag Text = PendingPayment (for example)
 +
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 +
 
 +
Booking Info tab: Optional
 +
Add a booking info tab for information and reporting
 +
*Booking Info Code = PENDPAY
 +
*Booking Info Text = Pending payment added
 +
 
 +
Invoice tab:
 +
*Payment Type = fixed value
 +
*Description = Security Deposit||[IF<=:[INVOICEFIRSTITEMNUM]:800:200|[INVOICEFIRSTITEMNUM][/.0]4]  
 +
(Security Deposit is the description, then 2 | symbol, then the calculation for the 'Amount' to be set.)
 +
 +
This calculation, tests if the first invoice item value (usually the Accommodation value) is greater than or = 800 if so set the Security Deposit Amount = 1 quarter of the first invoice item value, otherwise set = 200.
 +
 
 +
<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span>  <span style="font-weight: bold;" >Tip</span> A price value for the invoice item can be specified after a second pipe (|) symbol, this can be used to calculate a price using template variables. If the price value in the description field is zero or absent, the numeric value from the amount field will be used.
 +
 
 +
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
 +
*Amount = 0
 +
*Payment Rule = use auto or manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) Payments > Payment Rules they will be available here
 +
*Payment Due = Set when the payment is due
 +
 
 +
 
 +
Create a Payment Rule to collect a payments when bookings are not cancelled.
 +
 
 +
Go to Settings > Payments > Payment Rules
 +
 
 +
Payment Rule :
 +
 
 +
Name = Enter your title - Not Cancelled (for example)
 +
Action = Auto
 +
 
 +
Payment Trigger :
 +
 
 +
*Booking Status = All not cancelled
 +
*Any Booking Info Code = optional
 +
*All Booking Info Codes = optional
 +
*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 +
 
 +
Payment Action :
 +
 
 +
*Capture = Yes - immediately charged (Capture=Yes)
 +
*Add info code on success = add a Booking Info item to the booking on success
 +
*Add info code on failure = add a Booking Info item to the booking on failure
 +
 
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
''''Create a Payment Rule  (Optional)''''
 +
 
 +
Standard payment rules in the system are Auto & Manual, you can create additional rules for the collection of outstanding payments, you can control the collection of payments if the booking status is changed, for example the booking is cancelled before the final payment is due to be collected.
 +
 
 +
Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
 +
 
 +
Create a Payment Rule to collect payments if bookings are not cancelled.
 +
 
 +
Click '''Create New Payment Rule''' :
 +
 
 +
Payment Rule:
 +
*Name = Enter your title - Not Cancelled (for example)
 +
*Action = Auto
 +
 
 +
Payment Trigger :
 +
*Booking Status = All not cancelled
 +
*Any Booking Info Code (optional)
 +
*All Booking Info Codes (optional)
 +
*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 +
 
 +
Payment Action :
 +
*Funding Source = Guest card only
 +
*Payment value adjustment = Limit to group booking balance
 +
*Capture = Yes - immediately charged (Capture=Yes)
 +
*Add info code on success = add a Booking Info item to the booking on success
 +
*Add info code on failure = add a Booking Info item to the booking on failure
 +
 
 +
Prevent Auto Payment :
 +
*Prevent payment if booking status = Cancelled
 +
*Prevent payment after check-out (days) = 7 (default)
 +
*Prevent payment action = Set Manual
 +
 
 +
 
 +
'''Create Auto Actions '''
 +
 
 +
Collect the outstanding balance for bookings created via your booking page.
 +
 
 +
Go to {{#fas:cog}} (SETTINGS)  GUEST MANAGEMENT > AUTO ACTIONS and click '''Create New Action''' to create them.
 +
 
 +
'''Collect outstanding balance for direct bookings'''
 +
 
 +
Trigger tab:
 +
*Time
 +
**Trigger Event = Checkin
 +
**Trigger Time = -3 days (set the time you want to collect the payment)
 +
**Time Window = 3 days (set this to the same number (positive) as Trigger time.
 +
 
 +
*Booking Source
 +
**Booking Source = Direct. You can have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
 +
 
 +
*Booking Conditions
 +
**Group Booking Trigger = Trigger only Master
 +
**Status = All not cancelled
 +
**Invoice Balance= Not Zero (can be used to refine the auto action being triggered)
 +
 
 +
Booking tab: Optional
 +
*Flag Text = Pending payment added (for example)
 +
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 +
 
 +
Booking Info tab: Optional, for information and reporting
 +
*Booking Info Code = BALANCE (for example enter the value - use one word only)
 +
*Booking Info Text = Enter the description/text to show in for the Booking Info Code.
 +
 
 +
Invoice tab:
 +
 
 +
<div class="warning">{{#fas:exclamation-triangle}} ONLY use Payment Type =‘ Percent of Group balance due’ if you selected Trigger tab > Booking Conditions > Group Booking Trigger = Trigger Only  Master.</div>
 +
 
 +
*Add a Pending Payment to the booking
 +
**Payment Type = Percent of Group Balance due (select on what the payment is calculated)
 +
**Description = the text you will see in the "Charges and Payments" tab
 +
**Status = if you use the status function add the status you want to apply to the pending payment (optional)
 +
**Amount = 100 (this will be 100% of the outstanding group balance)
 +
**Payment Rule = Not Cancelled - See Step 4 above (if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS ->PAYMENT RULES they will be available here)
 +
**Payment Due = Trigger date
 +
**Payment time = set the time to collect payment
 +
**Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
 +
 
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
===='Capture' a Security Deposit when Credit card is collected at time of booking. ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
Trigger tab:
 +
*Trigger Event = Booking  
 +
*Trigger Time = immediate
 +
*Booking Source =All (for example, you can also set different rules for different channels)
 +
 
 +
Info Codes:
 +
Any Booking Info Code = CARDTOSTRIPE
 +
 
 +
Invoice tab:
 +
*Payment Type = Fixed amount
 +
*Description =  Security Deposit (the text you will see in the "Charges and Payments" tab)
 +
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
 +
*Amount = 100 (balance is full price so 100% of the balance)
 +
*Payment Rule = Security Deposit (Create a Payment Rule, see below)
 +
*Payment Due = check in
 +
 
 +
 
 +
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> Automatic collection is only available for customer who use [[Stripe]].
 +
 
 +
Create a Payment Rule to 'Capture' a payment only. Captured payments will only be valid for 7 days, then it will expire, if the booking is for a longer period, then you can create a second Capture, you will need to create another auto action for this.
 +
 
 +
Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
 +
 
 +
Payment Rule :  
 +
*Name = Enter your title - Security Deposit (for example)
 +
*Action = Auto
 +
 
 +
Payment Trigger :
 +
*Booking Status = select from the drop down list
 +
*Any Booking Info Code = optional
 +
*All Booking Info Codes = optional
 +
*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 +
 
 +
Payment Action :
 +
*Capture = Yes/No - immediately charged (Capture=Yes), if you want to make sure that the amount is available for later capture (Capture=No)
 +
*Add info code on success = add a Booking Info item to the booking on success
 +
*Add info code on failure = add a Booking Info item to the booking on failure
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply an info code and and/or icon when a payment was made====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Invoice Balance = Any Payment made
 +
 
 +
Booking Info tab:
 +
*Booking Info Code : Enter the preset code for the icon or info code which you have created in {{#fas:cog}} (SETTINGS) ACCOUNT->PREFERENCES.
 +
*Booking Info Text : Enter the text you wish to show
 +
 
 +
Process Template Variables : When created
 +
 
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Automatically apply invoice number at check-out - ''Select from predefined templates'' ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
'''Trigger tab:'''
 +
 
 +
*Trigger Event = Check-out
 +
*Trigger Time = Immediate
 +
*Time window = 1 day
 +
 
 +
Booking Conditions:
 +
*Status = Confirmed
 +
 
 +
Info Codes:
 +
*Any Booking Info Code = CHECKOUT (optional only if you use the check-out function)
 +
 
 +
'''Invoice tab:'''
 +
 
 +
*Assign Invoice Number = yes
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Using Pending Payments as a Payment Reminder====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking or Booking (but not after Check-in)
 +
*Trigger Time = set the time you want to add the pending payment to the booking
 +
*Booking Source =All (for example, you can also set different rules for different channels)
 +
 
 +
Booking Info tab:
 +
*Optional, add a booking info tab for information and reporting
 +
 
 +
Booking tab: Optional
 +
*Flag Text = PaymentDue1 (for example), set multiple if multiple payments are required.
 +
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 +
 
 +
Invoice tab:
 +
*Payment Type = select on what the payment is calculated (Percent of Balance due)
 +
*Description = the text you will see in the "Charges and Payments" tab
 +
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
 +
*Amount = enter the amount or percentage you want to collect
 +
*Payment Rule = Manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here
 +
*Payment Due = Set when the payment is due
 +
 
 +
The Pending Payment Report is available in Bookings > Pending Payments. This report can be used to see outstanding pending payments, this can be used to see all outstanding payments, when payment gateways other than Stripe are used, the Pending Payments report can be used to see outstanding payments and a checklist for bank transfers.
 +
 
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Test if Stripe Authorisation has expired and you need to trigger a new authorisation ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Stripe authorisations are dependent on a number of factors including your account type, credit card provider, Stripe rules and the guest bank provider.
 +
 
 +
If you have bookings that are longer than the authorisation period, you will need to create multiple authorisations. You can use the details below in an auto action to test the date/value of the text/description of the Booking info code = 'STRIPEAUTHORIZE'
 +
 
 +
For example you have a booking that is for 14 nights, but the authorisation period is 7 days.
 +
 
 +
Trigger tab:
 +
 
 +
*Trigger Event = Checkin
 +
*Trigger Time =  + 7 days
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
 
 +
Booking Conditions
 +
 
 +
*Group Booking Trigger = Trigger only Master
 +
*Status = All not cancelled
 +
*Invoice Balance= Any
 +
*Minimum Stay = 7
 +
*Maximum Stay = 14
 +
 
 +
Info Codes
 +
*Any booking info code = CARDTOSTRIPE, STRIPEAUTHORIZE
 +
*Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT
 +
 
 +
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.
 +
 
 +
Booking Fields
 +
*Template Variable = [IF<^[AUTHORIZEUNTIL{%Y-%m-%d}]^[CURRENTDATEYYYY-MM-DD]^yes~no] equal yes
 +
 
 +
The entry in the info tab of the booking will typically be
 +
 
 +
STRIPEAUTHORIZE Authorize 1500.00 EUR until 2024-08-14........
 +
 
 +
Check the substring numbers for your specific bookings, the date starts on the 28th char as the amount is 1500.00
 +
 
 +
Booking tab: Optional
 +
*Flag Text = Security Deposit Pending Payment (for example)
 +
*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 +
 
 +
Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.
 +
*Booking Info Code - REFDEPPP (for example)
 +
*Booking Info Text - Refundable Security Deposit pending payment
 +
 +
Invoice tab:
 +
*Add a Pending Payment to the booking
 +
*Payment Type = Fixed amount
 +
*Description = the text you will see in the "Charges and Payments" tab
 +
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
 +
*Amount = 1500 (enter the value you want to authorise on the guest credit card )
 +
*Payment Rule = Security Deposit (use the payment rule)
 +
*Payment Due = Trigger date
 +
*Payment time = set the time to collect payment
 +
*Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
 +
 
 +
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.
 +
 
 +
</div>
 +
</div>
 +
 
 +
===Booking Flags/Colours===
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Apply a flag when a booking is cancelled====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab
 +
*Trigger Event = Booking
 +
*Trigger Time = 1 Hour
 +
*Trigger Window = 365 days
 +
*Booking Status = Cancelled
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Booking Status = No Change
 +
*Flag text = (enter the text you require)
 +
*Flag Colour = 999999 default cancel colour - (Set as required)
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag for a bookings from a channel which have breakfast included====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Booking Source = Booking.com (for example)
 +
*Booking Field Contains  - select "API Message" in the next field enter: meal_plan=Breakfast  (or Extra Breakfast - use the text the channel uses)
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Flag Text = The text you want to display
 +
*Flag Colour - choose the flag colour
 +
 
 +
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag for a bookings which has BREAKFAST as a charge item====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Booking Source = Booking.com (for example)
 +
*Template Variable = [IF>:[INVOICEITEMBYDESC:Breakfast]:0:yes|no] (Text for Breakfast has to match EXACTLY what is in the booking item Uppercase/Lowercase/Proper)
 +
*Select 'equal' from the selection box
 +
*yes (needs to be exactly the same text/upper/lowercase, as in the equation)
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Flag Text = Breakfast
 +
*Flag Colour - choose the flag colour
 +
 
 +
Booking Info tab:
 +
*Booking Info Code = BREAKFAST
 +
*Booking Info Description = Breakfast included
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag when deposit was made prior to Check-in====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
 
 +
*Trigger Event = Check-in
 +
*Trigger Time = -365 (for example : must be a negative value and the same as the value in Trigger window)
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Invoice Balance = Any Payment made
 +
 
 +
Message tab:
 +
 
 +
*Send Email : select appropriate option
 +
*Enter : Subject and Email content
 +
 
 +
Booking tab: (optional)
 +
 
 +
*Execution = One time only
 +
*Flag Text = The text you want to display
 +
*Flag Colour - choose the flag colour
 +
 
 +
Booking info tab : (optional)
 +
 
 +
*Booking Info Code : DEPOSITPAID (for example)
 +
*Booking Info Text : additional text if required.
 +
 
 +
Setting details with the Booking tab and Booking info tab allows you to trigger additional (follow on) Auto Actions and Reports.
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Apply a flag when booking is fully paid====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All not cancelled
 +
*Invoice Balance = ZERO
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Flag Text = The text you want to display
 +
*Flag Colour - choose the flag colour
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag/colour for a booking coming from a certain channel - ''Select from the predefined template'' ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
'''Trigger tab:'''
 +
 
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Booking Source = Booking.com (for example)
 +
 
 +
'''Booking tab:'''
 +
 
 +
*Execution = One time only
 +
*Flag Text = The text you want to display
 +
*Flag Colour - choose the flag colour
 +
 
 +
Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the email.
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag when NO payment is made - ''Select from the predefined template''====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
'''Trigger tab:'''
 +
 
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
 +
 
 +
Booking Source:
 +
*Booking Source = All
 +
 
 +
Booking Conditions:
 +
*Booking Status = All not cancelled
 +
*Invoice Balance = No payment made
 +
 
 +
'''Booking tab:'''
 +
 
 +
*Execution = One time only
 +
*Flag Text = Not Paid
 +
*Flag Colour = fee0dd
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag when a payment was made====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span>  Also see Example : " Apply a flag when deposit was made prior to Check-in AND/OR Apply a flag when booking is fully paid".
 +
 
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Trigger Window = 365
 +
*Booking Source = All
 +
*Booking Status = All not cancelled
 +
*Invoice Balance = Any Payment made
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Flag Text = The text you want to display
 +
*Flag Colour - choose the flag colour
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag when a payment FAILS at Stripe - ''Select from predefined template'' ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 +
'''Trigger tab:'''
 +
 
 +
*Trigger Event = Booking (but not after check-in)
 +
*Trigger Time = Immediate
 +
*Trigger Window = 999
 +
 
 +
Booking Source:
 +
*Booking Source = All
 +
*Booking Status = All but not cancelled
 +
*Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE
 +
 
 +
'''Booking tab:'''
 +
 
 +
*Execution = One time only
 +
*Flag Text = Stripe Payment Failed
 +
*Flag Colour - fee0dd
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
====Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
Go to Settings > Channel Manager > Preferences and set Auto report failed cards = Yes
 +
 +
'''Trigger tab:'''
 +
 
 +
*Trigger Event = Booking (but not after checkout)
 +
*Trigger Time = Immediate
 +
*Trigger Window = 999
 +
 
 +
Booking Source:
 +
*Booking Source = Booking.com
 +
 
 +
Booking Conditions:
 +
*Booking Status = All not cancelled
 +
*Booking Info Code = BOOKINGCOMCARD
 +
 
 +
'''Booking tab:'''
 +
 
 +
*Execution = One time only
 +
*Flag Text = Failed CC reported to Booking.com
 +
*Flag Colour - choose the flag colour
 +
</div>
 +
</div>
 +
 
 +
===Status changes===
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
==== Change the status of all "Request" bookings to "Cancelled" after three days ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab
 +
*Trigger Event = Booking
 +
*Trigger Time = 3 days
 +
*Booking Status = Request
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Booking Status = Cancelled
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
==== Change the status of Airbnb "Inquiry" bookings to "Cancelled" after three days ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab
 +
*Trigger Event = Booking
 +
*Trigger Time = 3 days
 +
*Booking Status = Inquiry
 +
*Booking Source = Airbnb
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Booking Status = Cancelled
 +
 
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
==== Change the status of all bookings which have been imported from Ical to "Request" ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab:
 +
*Trigger Event = Booking
 +
*Trigger Time = Immediate
 +
*Booking Source = Ical Import (1, 2, 3)
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Booking Status = Request
 +
 
 +
Booking changes are applied before the mail is sent.
 +
</div>
 +
</div>
 +
 
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 
 +
==== Change Room Unit Status when guest checks out ====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Trigger tab
 +
*Trigger Event = Check-out
 +
*Trigger Time = Immediate
 +
*Trigger Window = 1 day
 +
*Booking Status = All but not cancelled
 +
*Any Booking Info Code = CHECKOUT
 +
 
 +
Booking tab:
 +
*Execution = One time only
 +
*Change Room Unit Status = Select the option
 +
 
 +
It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
 +
</div>
 +
</div>
 +
 
 +
===API/Webhook===
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Use API/Webhook to write to the field 'Message'====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
You can use a webhook in conjunction with the API JSON function '''setBooking''' to write to any field in the booking. First you have to configure access to the API:
 +
 
 +
You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
 +
'''API key:'''
 +
*{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
 +
*API Key = my_very_secret_api_key
 +
*API Key Access = allow any IP
 +
*IP Whitelist = [leave empty]
 +
*Allow Writes = Yes
 +
*Property Access = Owned by this account only
 +
*'''Property key:'''
 +
*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX
 +
 
 +
Set the triggers you need, for example:
 +
 
 +
Booking Field Contains: Message = XXX
 +
 
 +
Set the webhook like this:
 +
 
 +
* URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
 +
* Custom Header = [leave empty]
 +
 
 +
Body Data:
 +
:{
 +
::"authentication":
 +
::{
 +
:::"apiKey": "my_very_secret_api_key",
 +
:::"propKey": "secret_key_for_prop_XXXXXX"
 +
::},
 +
::"bookId": "[BOOKID]",
 +
::"message": "[MESSAGE] - Append this message"
 
:}
 
:}
 +
</div>
 +
</div>
 +
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 +
====Use API/Webhook to write the value of the 'commission' field to a new invoice item====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
You can create a new invoice item that contains the price of the channel's commission as a negative value to subtract it from the room price. You use the API JSON function '''setBooking''' for this. First you need to configure access to the API:
 +
 +
You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
 +
'''API key:'''
 +
*{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
 +
*API Key = my_very_secret_api_key
 +
*API Key Access = allow any IP
 +
*IP Whitelist = [leave empty]
 +
*Allow Writes = Yes
 +
*Property Access = Owned by this account only
 +
*'''Property key:'''
 +
*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS> propKey = secret_key_for_prop_XXXXXX
 +
 +
Set the triggers you need, for example:
 +
 +
Booking Source = Booking.com
 +
 +
Set the webhook like this:
 +
 +
*URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
 +
*Custom Header = [leave empty]
 +
 +
*Body Data =
 +
:{
 +
::"authentication":
 +
::{
 +
:::"apiKey": "my_very_secret_api_key",
 +
:::"propKey": "secret_key_for_prop_XXXXXX"
 +
::},
 +
::"bookId": "[BOOKID]",
 +
::"invoice":
 +
::[
 +
:::{
 +
::::"description": "Booking.com Commission",
 +
::::"status": "",
 +
::::"qty": "1",
 +
::::"price": "-[COMMISSIONNUM]",
 +
::::"vatRate": "7.00",
 +
::::"type": "0",
 +
::::"invoiceeId": ""
 +
:::}
 +
::]
 +
:}
 +
</div>
 +
</div>
 +
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 +
====Use Auto Action/Webhook to write to send data to Integromat====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 +
You can use this option to send data to your Integromat account.
 +
 +
Set the rules in the Trigger tab, when you need to send the data to Integromat.
 +
 +
Go to Webhook tab:
 +
 +
URL = https://hook.integromat.com/ followed by your integromat account key.
 +
 +
Body Data = you can use the template variables allows in the list for Integromat [[https://wiki.beds24.com/index.php/Make#Data_Fields Data fields]]
 +
 +
For example :-
 +
 +
bookingData={
 +
 +
"bookId":"[BOOKID]",
 +
 +
"guestMobileNum":"[GUESTMOBILENUM]",
 +
 +
"guestMobile":"[GUESTMOBILE]",
 +
 +
"guestSMS":"[GUESTSMS:44]",
 +
 +
"guestFirstName":"[REPLACE|&|and|[GUESTFIRSTNAME]]",
 +
 +
"propertyName":"[PROPERTYNAME]",
 +
 +
"propertyId":"[PROPERTYID]",
 +
 +
"firstNight":"[FIRSTNIGHTSHORT]",
 +
 +
"lastNight":"[LEAVINGDAYSHORT]"
 +
 +
}
 +
 +
</div>
 +
</div>
 +
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
 +
====Use webhook to switch a Shelly on====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
Here is a simple PHP script with which you can switch a Shelly via an autoaction in beds24.
 +
 +
You can use this to switch on a string of lights on the day of arrival or to charge the night storage heating if a certain info code is set in the booking on the day before arrival.
 +
 +
Create an auto action and enter the PHP script ‘beds24-shelly-steuern.php’ under ‘Webhook’. The parameters for the control are transferred under ‘Data in body’:
 +
 +
id:b0b21c1xxxxx
 +
shelly_server:shelly-123-eu.shelly.cloud
 +
auth_key:ABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZ
 +
shelly_url:device/relay/control
 +
parameter:channel=0&turn=on
 +
email_result:[email protected]
 +
remarks:Text, z.B. mit Template Variablen [GUESTFULLNAME] und [BOOKID]
 +
 +
</div>
 +
</div>
 +
 +
===Testing for Modified bookings===
 +
<div class="mw-collapsible mw-collapsed">
 +
<div  class="headline-collapse" >
 +
====Use Template Variables to test for Modified bookings====
 +
</div>
 +
<div class="mw-collapsible-content">
 +
 +
You can test if the booking has been modified, adding a booking info code to the booking will then allow you to trigger other auto actions, run reports etc.
 +
 +
Trigger tab
 +
*Trigger Event = Booking (but not after Check-in) OR Booking
 +
*Trigger Time = 1 day (this will ensure that NEW bookings do not trigger this auto action)
 +
*Time Window = 365 days
 +
*Booking Status = All not cancelled
 +
 +
*Template Variables [IF>^[MODIFYDATE:{%Y-%m-%d %H:%M:%S}]^[CURRENTDATE:-1day{%Y-%m-%d %H:%M:%S}]^yes~no] equal yes
 +
 +
Booking tab: (Optional)
 +
*Flag text = (enter the text you require)
 +
*Flag Colour = Set as required
 +
 +
Booking Info tab : (optional)
 +
*Booking Info Code = MODIFIED
 +
*Booking Info Text = Booking modification
 
</div>
 
</div>
 
</div>
 
</div>

Latest revision as of 11:30, 4 November 2024

Auto Actions
This page is about the menu  (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS and explains how to set up and use Auto Actions.

Contents

1 Summary

An Auto Action is an action which can be used manually or programmed to run automatically at a specific time relative to the time of the booking, to the check-in date or to the check-out date.

Auto actions have one or more trigger conditions and one or more actions. They can be triggered on a number of different conditions, like property, time or booking related conditions. Auto Actions can

  • send pre-drafted Emails, messages or SMS
  • change booking information
  • change invoice information
  • run webhooks
  • trigger HTTP POST notifications

You can create chains of actions to automate workflows.

2 General Information

Template variables provide great flexibility when creating/managing the Auto Actions. Setup one Auto Action to trigger on multiple/all properties/rooms with the property specific details, using the Template Variables. This removes the need to duplicate your auto actions for each Property. Reducing the ongoing management, multiple copies of the same auto action will require you to edit/modify each auto action rather than update one auto action.

Using 'Group Keywords' you can refine the triggers in the Auto Action to include/exclude properties if the purpose/message in the Auto action needs to be different.

Auto Actions are not designed as real-time actions. They are sent in batches at times so we recommend you set your triggers to allow for this.

3 Setup

Go to (SETTINGS) GUEST MANAGEMENT > AUTO ACTION

  • Click 'Add New Action' button. You can choose whether you want to start with an empty Auto Action or whether you want to use a template that you can customise further.
  • To MODIFY an Auto Action, scroll to the Auto Action and click on "Edit", make the changes and click SAVE.
  • To create a COPY of an Auto Action, click "Edit" on an existing auto action, scroll to the bottom of the page and click 'Save as copy'.
  • To DELETE an Auto Action, click "Edit" on an existing auto action, scroll to the bottom of the page and click 'Delete'.

Trigger Action :

You can choose to trigger an auto action automatically or manually.

  • Manual: If set to manual actions can be triggered manually from the MAIL/ACTION tab of each booking.
  • Auto: Auto action will automatically trigger on a booking based on the rules set in the Trigger tab. Check the details in the MAIL/ACTION tab of each booking. You will see if the auto action has triggered and when, if it has not triggered then you can check if it is due to trigger and when.

3.1 Setup Outgoing Email Service - Required for sending Emails via Auto Actions

Go to (SETTINGS) ACCOUNT -> OUTGOING EMAIL and follow the instructions to connect your email address/account to Beds24.

Auto sending:

The auto action batch process runs multiple times per hour.

Auto Action Emails which are sent automatically by the system are sent from the EMail address of the account that created the Auto Action. This is the account set up in in (SETTINGS) ACCOUNT-> OUTGOING EMAIL.

Manual sending:

When sending manually by clicking on the 'Send now' button the Email address of the user you are logged in as will be be used.

To use this function you need to set the system to use your own Email address for outgoing emails under (SETTINGS) ACCOUNT -> OUTGOING EMAIL.

Confirmation emails will send automatically to the guest. You can customize them in (SETTINGS) GUEST MANAGEMENT -> CONFIRMATION MESSAGES.

The auto actions will appear on the 'Mail & Actions' tab of each booking where you manually trigger the email/messages/changes to the booking.

If you are using your own mail server for outgoing email/messages the Booking and Invoice actions will be applied before sending the mail.

3.2 Auto Actions and Subaccounts

Auto Actions are account functions, i.e. they apply per account.

1. Account A (master account or subaccount) in which the auto action was created.

Auto Actions are available according to the "Property" setting in the "Trigger" tab. I.e. either for

  • A specific property or a group of properties
  • All properties belonging to that account
  • all properties visible in the account (properties belonging to the account, properties available in the account).

2. Another account B (master account or sub-account) in which the Auto Action has not been created.

Auto Actions are only available for properties that belong to Account A and have been made available in Account B.

If required, Auto Actions can be copied from one account to another using the "clone" function. This creates an independent Auto Action in another account, which can be changed there. The clone function is available via the 'User' icon on the top right and then on 'Account Management (in the old control panel SUB ACCOUNT in the top right).

If you have sub accounts and need an auto action to be used across multiple accounts/properties, then create the auto action at the Master Account Level and set Property = 'All visible in account' and ensure the Master account has access to the properties.

4 Trigger

Sets the criteria which have to be fulfilled to start the Auto Action.

Property, Room, Unit

You can refine the use of the Auto Action, by specifying if it should trigger on specific properties or all properties/rooms.

You can select if it should trigger on All properties, All Owned by, All visible in account or a specific Property. If you select a specific Property then you can also select a specific Room id.

It is possible to 'Exclude' specific Beds24 Room ids, you can find the Room id from the Room Setup.

If required, you can also specify specific Offers/Units in Room Types.

Send/Exclude Property Groups, this will use the values you have entered in (SETTINGS) BOOKING PAGE > MULTIPLE PROPERTIES > PROPERTY SETTINGS > GROUP KEYWORDS.

Time

"Trigger Time" and "Trigger Event" define when the action is allowed to start. Once it has started it is allowed to go for the "Time Window" period. When the "Time Window" period has elapsed the auto action stops.

Both "Trigger Time" and "Time Window" are relative to a "Trigger Event" i.e. check-in, check-out, time of booking.

"Between Booking and Check in" can be used to include/exclude Same day/Near term bookings, set the number of days.

"Check In From" and "Check In To" use if you have specific information relating to bookings between these dates, special offers, major disruptions etc.

Booking Source

"Booking Source" = "Direct" applies the Auto Actions only to bookings from your own web site, manually added bookings and bookings imported though the API (not the channel manager). If you want to trigger only on manually added bookings add your username in the "Referrer" field.

Booking Conditions

"Group Booking Trigger" - use the (?) context help for the options. "Invoice Balance" - use this to for payments and reminders.

Info Codes

If you use Booking Info Codes in your bookings, you can enter values to include/exclude bookings.

Booking Fields

Select the appropriate fields from the drop down lists. You can also use an AND/OR option.

"Template variables" can be used in the fields to generate dynamic values based on the booking. See the options in this section Smart Template Variables

5 Actions

5.1 Messaging/Email

Go to "Messaging" to create or modify a prepared Email/Message template. Templates can contain Template Variables to include information specific to the booking in the Email/Message, for example the guests name or the arrival date.

  • To send messages via the Message API, then enter the text in the PLAIN text box, for emails, enter the text in the HTLM Box.
  • To send Emails automatically you need to set up your outgoing Email address in (SETTINGS) ACCOUNT -> OUTGOING EMAIL.
  • To send Emails manually open a booking and go to the MAIL/Action tab. Manual Emails will open in a window, you may send it as is or edit it before sending.

Some systems have a limit of about 2000 characters for this form of email generation. If the email will not open try reducing the amount of text.

If Auto Action Emails are sent automatically they will send through your Email server. You should see this on your server. Whether you see it in your Sent box or not depends on your Email program.

If Auto Action Emails are sent manually via a link in the "Email Templates" list in the booking Beds24 will first try to send through your Email server. You should see this on your server. Whether you see it in your Sent box or not depends on your Email program.

If this does not work it will pop and send through your desktop. In this case you will see it in your Sent box.

5.1.1 Email Attachments

You can choose to attach an invoice or a booking template as a PDF file to emails sent by Auto Actions.

If you send Emails with pdf attachment (invoice, booking template) to Alias-Email addresses created by channels the channel might block the attachment so it is not delivered to the guest. Ask your channel about their policy regarding this.

Other files can not be attached. We recommend you use a link to a file you upload to your web site.

5.2 HTML and Templates

If you use HTML you will need to make sure your code is correct and clean otherwise it might trigger our firewall.

HTML messages created by third party services is often convoluted and might contain critical content. Some tools like https://stripo.email/ or https://www.designedwithbee.com/ that allow you to create your own templates and also provide many templates have tested to work well in Beds24.

5.3 SMS

You can automatically send SMS messages. Please note that a fee per SMS message applies if this function is activated.

SMS can only be used to communicate Information about a current booking. For legal reasons you can not use SMS for marketing purposes including discounts or vouchers.

The SMS will send in the language of the account, not the language of the booking. Read Example "Send an Email in the guests language to an internal Email address" for a way to control the language of the SMS.

5.4 Booking

Go to the tab 'Booking' to set up an auto action which modifies something in the booking.

"Execution" - default is 'One time only' or 'Allow Repeats' This action can run one time only or repeat within the trigger time period.

Emails are always triggered once only regardless of this setting.

5.5 Booking Info

Set up auto actions which automatically add or remove info codes. This is good practice for reporting and also to trigger/exclude bookings from other auto actions.

Booking info codes can be used to 'sequence' your auto actions.

For example, you have an auto action that sends a message to the guest, but only after another action has already triggered.

Consider the auto action to add a pending payment to a booking for the Security deposit authorisation, this should only be triggered when the Booking info code = STRIPEPAYEMNT or CARDTOSTRIPE, both confirm the guest credit card is in the booking.

5.6 Invoice

Automatically Assign Invoice Number.

Automatically add/update invoice items or pending payments.

Pending payments can use Payment Rules defined in (SETTINGS)->PAYMENTS->PAYMENT RULES.

Invoice changes are applied before the mail is sent.

5.7 API

Create auto actions which trigger HTTP POST notifications.

5.8 Webhook

Create auto actions which trigger a web hook when the trigger conditions are met.

6 Multiple Properties

With Multiple Properties, the requirement to have Property specific information in the Messages/emails sent to the guest/housekeeping/owner can be achieved using Template Variables.

When you create a Property/Room in Beds24, the setup of the Property/Room is held in the database and can be accessed via Template Variables. For example in (SETTINGS) >PROPERTIES >DESCRIPTION, you setup the property specific details.

  • Property name - can be accessed in template variable [PROPERTYNAME]
  • Property Address - can be accessed in template variable [PROPERTYADDRESS]

You will find the full list of Property Template Variables when you go to Property Variables

There are additional Property Templates that can be used in Messages/Emails/SMS to the guest that can be customised for each Property. Each Property Template can hold customised text that can be used in Auto Actions, Booking Templates, Invoices and Reports.

Go to (SETTINGS) >PROPERTIES >DESCRIPTION >PROPERTY TEMPLATES you will see the list that are available.

When you create each Room/Unit the information is held in Room/Unit specific template variables.

You will find the full list of Room/Unit Template Variables when you go to Room Variables

See the full list of Template Variables.

You can send a message/email to your guests, confirming their booking date, property details and property contact details. Use the property, room and booking templates to build the message/email in one Auto Action, rather than one auto action per property.

This approach will reduce the ongoing management, update one Auto Action and it will apply to all/selected properties rather than having to edit multiple auto actions with the same overall message.

6.1 Example 1 - Each property has a different access code for the main building door

Your properties have security doors with keycodes, each property has a different code.

Go to (SETTINGS) >PROPERTIES >DESCRIPTION >PROPERTY TEMPLATES > Property Template 1 enter the Building Access Code, use this same field in each property and set the appropriate code.

Then in the Auto Action use [PROPERTYTEMPLATE1] in the text rather than the actual value.

  • Please use this code to Access the Main building Door:- [PROPERTYTEMPLATE1]

There is no need for a separate auto action due to the front door keycode being different.

6.2 Example 2 - Housekeeping/Cleaning Team is different for each Property.

Each of your properties has a different housekeeping/cleaning team and you need to send them an email with the booking details for each booking.

Go to (SETTINGS) >PROPERTIES >DESCRIPTION >PROPERTY TEMPLATES > Property Template 5 enter the email address for Housekeeping/Cleaning team.

In the Auto action,

  • "Send Message" = Internal Only.
  • "Internal Email Address" = [PROPERTYTEMPLATE5]

There is no need for a separate auto action as the message will be sent to the appropriate email from property template 5.

If you have different teams per room, then use a Room template rather than the Property Template.

6.3 Example 3 - Send email to a Group of Properties (not all)

You can setup a "Group" for your Properties, this has a number of benefits, including sending/excluding messages/emails to a Group of Properties, view a "Group" of properties in your Calendar and in Reports.

To assign the "Group" to your Properties, go to (SETTINGS) > BOOKING ENGINE > MULTI BOOKING PAGE > PROPERTY SETTINGS > GROUP KEYWORDS.

Enter a Group name, it needs to be a single word - for example you want to identify all 4 bedroom properties, then you can add 4BEDS and add this to all 4 Bedroom properties you have.

Each property can be in multiple groups, enter multiple keywords separated by a comma, for example :- 4BEDS, OceanView, Dublin.

In the Trigger tab of the Auto Action, enter the Group keyword in

  • "Send Only To Property Groups" OR "Exclude Property Groups" you want to include/exclude from the Auto Action.

This filter will not apply if you are triggering on a single property.

7 Using Smart Logic Template Variables

You can use smart logic template variables to trigger auto actions for specific conditions.

If you want to send a message on a specific day of the week :-

1) You need to send a message to remind the guests to put the rubbish bin out for collection on a Wednesday night.

  • [IF=:[CURRENTDATE:{%u}]:3:yes|no] will test if the current date is a Wednesday

2) Remind the guest that the cleaning lady will be at the apartment on Friday morning.

  • [IF=:[CURRENTDATE:{%u}]:4:yes|no] will test if the current date is a Thursday
%u 	ISO-8601 numeric representation of the day of the week 	1 (for Monday) through 7 (for Sunday)

8 Performance and Testing

Auto actions will test up to 1000 bookings per cycle, if your trigger condition involves more than 1000 bookings, the next 1000 will be tested on the next cycle etc. If you require the fastest speed, ensure your trigger is designed to test less than 1000 bookings.

The easiest way to do this is usually by reducing the testing window to the smallest necessary and adjusting the trigger condition to the most suitable. For example a trigger that tests all bookings from booking time for 1 year will test many bookings while a trigger that tests only the 7 days before check-in will test less bookings and perform faster.

The test tab of the auto action has a button that will show you how many and which bookings are being tested by the auto action.

It is also possible to specify a booking number and test if the auto action would trigger on that booking with some diagnostics information shown to help trouble shooting.

Optimising your auto actions You can trigger multiple actions in one auto action,

  • send an email/api message to the guest,
  • send an SMS, update booking settings,
  • add/delete a booking info code,
  • trigger a webook,
  • add a pending payment,
  • update/add/delete a Charge/Payment item,
  • assign an invoice number.

There is no requirement to set an individual auto action for each item if they can all apply at the same time.

It is not possible to specify a specific time for the auto action to trigger. The use of the Trigger time 'Immediate' + 14 hrs (for example) will not trigger the auto action at 2pm local time, this will be the first time the booking could be checked to see if all other conditions are met, and added to the batch for processing.

9 Troubleshooting

If Auto Actions do not send:
The list in the "Mail" tab of the booking will tell you why. Common causes are: 
*Is your outgoing Email address working? Go to  (SETTINGS) ACCOUNT->OUTGOING EMAIL and click on "Send Test Email".
*Is your Auto Action set to send automatically?
*Is the guests Email address valid ("Mails" tab of the booking)?
*Is the Plain Text box populated with the text you want to send (required when Message API is being used?
*Is the booking set to allow Allow Auto Actions ("Mails" tab of the booking)?
*Do all trigger events apply to the booking?
Delayed trigger of Auto Action:
See section Performance and testing above. 
Auto Action is not editable
To have write access to an auto action an account needs to have write access to all properties to which the auto action applies. This might not be the case if you use sub accounts and the Auto Action is set to trigger for "All Properties". 
You don't have permission to access control2.php on this server error message, when the save button is clicked
It is most likely something in your content triggering the firewall.
Try adding the content bit by bit until you find the item causing the problem.
Often it is a script or HTML item that appears to the firewall as a possible hacking attack.
It can also be something that looks innocent like a combination of numbers and words like "and" or "or" that hackers often use in sql injection attacks.
Once you find the item causing the problem, try rewording it.
Auto Action is not visible in a sub account
If you have sub accounts and need an auto action to be used across multiple accounts/properties, then create the auto action at the Master Account Level and set Property = 'All visible in account' and ensure the Master account has access to the properties.

10 Examples

10.1 Send Emails/Message/SMS to guests

Message API messages will be shown in the message tab of the booking and in the Channel Message centre. Currently this is only available for Booking.com and Airbnb.

10.1.1 Send an Email to the guest when the status of a booking changes to "Cancelled"

Trigger tab:

Time:

  • Trigger Event = Check-in
  • Trigger Time = -365
  • Trigger Window = 365

Booking Source

  • Booking Source = All (for example)

Booking Conditions

  • Booking Status = Cancelled

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used see here


If you are using deposit collection make sure you set (SETTINGS) PAYMENTS->PAYMENT COLLECTION "Non Payment Booking Status" = Request.

10.1.2 Change the status of all upcoming direct bookings to "Cancelled" and send an Email to the guest

Trigger tab:

Time:

  • Trigger Event = Check-in
  • Trigger Time = -14 (for example to cancel the bookings for the next two weeks)
  • Trigger Window = 14

Booking Source:

  • Booking Source = Direct

Booking Conditions:

  • Booking Status = All Not Cancelled

Booking tab:

  • Booking Status = Cancelled

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain Text Box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used see here

10.1.3 Send an message or SMS to Guest when booking made more than 10 days in advance

Trigger tab:

Time:

  • Trigger Event = Check-in
  • Trigger Time = -365 days
  • Trigger Window = 355 days

Booking Conditions:

  • Booking Status = All not cancelled

Booking tab:

  • Execution = One time only
  • Booking Status = No Change

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain Text Box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used see here


SMS tab :

Please note a charge applies per SMS message. 
  • Send SMS Message : Enable
  • Phone Number : This is the phone number that will receive the SMS notification.

This is a global service and the notifications can be sent to almost phone in any country.

The phone number must contain the international country code and phone number as it would be dialed internationally.

Do not include any leading zeros or other characters and use no spaces.

The number must start with the country code.

EXAMPLE

to send to phone number 015625346 in the UK (Country code 44) enter the following number

4415625346

You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.

  • SMS Message

Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.

10.1.4 Send an message or SMS to Guest when booking made more than 7 days in advance

Alternatively you an use Between Booking and Check in

Trigger tab:

Time:

  • Trigger Event = Booking (but not after check-in)
  • Trigger Time = Immediate
  • Trigger Window = 1 day
  • Between Booking and Check in = 7 to 999

Booking Conditions:

  • Booking Status = All not cancelled


Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used see here


SMS tab :

Please note a charge applies per SMS message. 
  • Send SMS Message : Enable
  • Phone Number : This is the phone number that will receive the SMS notification.

This is a global service and the notifications can be sent to almost phone in any country.

The phone number must contain the international country code and phone number as it would be dialed internationally.

Do not include any leading zeros or other characters and use no spaces.

The number must start with the country code.

EXAMPLE

to send to phone number 015625346 in the UK (Country code 44) enter the following number

4415625346

You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.

  • SMS Message

Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.

Booking tab:

  • Execution = One time only
  • Booking Status = No Change

10.1.5 Send an message or SMS to Guest for last minute booking - 6 days or less

Trigger tab:

Time:

  • Trigger Event = Booking (but not after check-in)
  • Trigger Time = Immediate
  • Trigger Window = 1 day
  • Between Booking and Check in = 0 to 6

Booking Conditions:

  • Booking Status = All not cancelled


Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain text box above. Template variables can be used see here


SMS tab :

Please note a charge applies per SMS message. 
  • Send SMS Message : Enable
  • Phone Number : This is the phone number that will receive the SMS notification.

This is a global service and the notifications can be sent to almost phone in any country.

The phone number must contain the international country code and phone number as it would be dialed internationally.

Do not include any leading zeros or other characters and use no spaces.

The number must start with the country code.

EXAMPLE

to send to phone number 015625346 in the UK (Country code 44) enter the following number

4415625346

You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.

  • SMS Message

Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.

Booking tab:

  • Execution = One time only
  • Booking Status = No Change

10.1.6 Send an Email with a key code for a specific unit one day before check-in (Self Checkin)

Trigger tab:

Property, Room, Unit:

  • Unit = Select the number of the unit you want to send this message to. Note that the number represents the index of the unit not its name.

Time:

  • Trigger Event = Check-in
  • Trigger Time = -1 day
  • Trigger Window = 1 day

Booking Conditions

  • Booking Status = All not cancelled

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. Template variables can be used see here

If you are using the "Additional Information" function (SETTINGS) PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables

Example: Your room is [UNITNAME]. Check-in from: [UNITNAME:1] . The key code is: [UNITNAME:2]

The template variables will only work if you have entered text in (SETTINGS) PROPERTIES->ROOMS->SET UP "Unit Names". The context help for this setting will explain how to do this.


  • HTML box - Email will be sent

If you are using the "Additional Information" function SETTINGS- (SETTINGS) PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables see here

Example: Your room is [UNITNAME]. Check-in from: [UNITNAME:1] . The key code is: [UNITNAME:2]

The template variables will only work if you have entered text in S (SETTINGS) PROPERTIES->ROOMS->SET UP "Unit Names". The context help for this setting will explain how to do this.

Booking tab:

  • Execution = One time only
  • Booking Status = No Change

10.1.7 Send an Email to the guest when a payment is made

Trigger tab:

Time:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365 day

Booking Conditions:

  • Booking Status = All not cancelled
  • Invoice Balance = Any Payment made OR Invoice Balance = Zero (payment in full)

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. Template variables can be used see here

You should consider adding the invoice table to the email so the guest can see the booking details including Charges & Payments.

[INVOICETABLE] - invoice table

It is also possible to include a customised invoice table using this template variable :- [INVOICE:PRI_QTY_CUA€] will create an invoice table with price and quantity in Euros

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details as in the Plain text box above. Template variables can be used see here

You should consider adding the invoice table to the email so the guest can see the booking details including Charges & Payments.

[INVOICETABLE] - invoice table

It is also possible to include a customised invoice table using this template variable :- [INVOICE:PRI_QTY_CUA€] will create an invoice table with price and quantity in Euros.

10.1.8 Apply a flag/colour to a booking when a payment is made - Select from the predefined template

Trigger tab:

Time:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 999 day

Booking Conditions:

  • Booking Status = All not cancelled
  • Invoice Balance = Any Payment made

Booking tab:

  • Flag Text = Paid
  • Flag Colour = d4e4b0

10.1.9 Email confirmation for channel bookings - Select from the predefined template

Trigger tab:

Time

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1 day

Booking Source

  • Booking Source = Channel Manager

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details as in the Plain Text box above. Template variables can be used see here

Booking tab:

  • Execution = One time only
  • Booking Status = No Change

10.1.10 Send a message (Email or sms) to guests that have Checked-out 30 days or more

Trigger tab:

Time

  • Trigger Event = Check-out
  • Trigger Time = 30 days
  • Trigger Window = 365 days

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details as in the Plain text box above. Template variables can be used see here

SMS tab :

Please note a charge applies per SMS message. 
  • Send SMS Message : Enable
  • Phone Number : This is the phone number that will receive the SMS notification.

This is a global service and the notifications can be sent to almost phone in any country.

The phone number must contain the international country code and phone number as it would be dialed internationally.

Do not include any leading zeros or other characters and use no spaces.

The number must start with the country code.

EXAMPLE

to send to phone number 015625346 in the UK (Country code 44) enter the following number

4415625346

You can use the template variables [GUESTPHONE] or [GUESTMOBILE] but this will only work if the phone number has exactly the required format.

  • SMS Message

Enter the message to send, messages will be truncated at 160 characters. Template variables can be used.

Booking tab: (optional)

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

10.1.11 Send a Request for payment to your guests for all bookings

Trigger tab:

Time

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1 day

Booking Source:

  • Booking Source = ALL (or select the booking source/Channel)

Message tab: Update details as appropriate

  • Send Message = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.

If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.

  • Plain text box (Using Message API)

Subject - enter the subject for your Guests Plain Text Message :- enter the Message text you wish to send to your guests include the payment link

https://beds24.com/bookpay.php?bookid=[BOOKID]

You can find extra options to add to the payment link if you want to refine the details

https://wiki.beds24.com/index.php/Category:Payments#Payment_Request

  • HTML Message (Send Email)

Email Subject - enter the subject for your Guests Email Text :- enter the Email text you wish to send to your guests include template variable [PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.

10.1.12 Send a Request to update the guest's credit card as it will expire before checkin

Trigger tab:

Time:

  • Trigger Event = Booking (not after check-in)
  • Trigger Time = Immediate
  • Trigger Window = 1 day

Booking Souce:

  • Booking Source = ALL (or select the booking source/Channel)

Message tab:

  • Send Email = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.

If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.

  • Plain text box (Using Message API)

Subject - enter the subject for your Guests Plain Text Message :- enter the Message text you wish to send to your guests including the payment link

https://beds24.com/bookpay.php?bookid=[BOOKID]&g=cc

You can find extra options to add to the payment link if you want to refine the details

https://wiki.beds24.com/index.php/Category:Payments#Payment_Request

  • HTML Message (Send Email)

Edit Email Subject - enter the subject for your Guests Edit Email Text :- enter the Email text you wish to send to your guests including the payment link

https://beds24.com/bookpay.php?bookid=[BOOKID]&g=cc this creates a link (HTML A tag) so the guest can enter their credit card details. Check the template variables for other options.

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.

Booking Info tab:

  • Booking Info Code = NEWCARDREQ
  • Booking Info Text = New credit card requested

10.1.13 Send a Request for payment to your guests XX days before check-in

Trigger tab:

Time:

  • Trigger Event = Check-in
  • Trigger Time = -42
  • Trigger Window = 42 day

Booking Souce:

  • Booking Source = ALL (or select the booking source/Channel)

Message tab:

  • Send Email = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.

If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.

  • Plain text box (Using Message API)

Subject - enter the subject for your Guests Plain Text Message :- enter the Message text you wish to send to your guests include the payment link

https://beds24.com/bookpay.php?bookid=[BOOKID]

You can find extra options to add to the payment link if you want to refine the details

https://wiki.beds24.com/index.php/Category:Payments#Payment_Request

  • HTML Message (Send Email)

Edit Email Subject - enter the subject for your Guests Edit Email Text :- enter the Email text you wish to send to your guests include template variable [PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.

10.1.14 Send a Request for payment to your guests XX days after booking

You allow your guests to make X number of payments for their booking.

You can not trigger the auto action multiple times, unless you manage this manually, therefore you need to create multiple auto actions, so if you allow 3 payments for their booking, then you will need 3 auto actions.

You will need to manually add a Booking Info Code to each booking that you have agreed to allow X payments.

Create Auto Action one

Trigger tab:

  • Trigger Event = Booking (but not after check-in)
  • Trigger Time = +7 days
  • Trigger Window = 1 day
  • Booking Source = ALL (or select the booking source/Channel)
  • Invoice Balance = Not Zero
  • Any Booking Info Code = MULTIPLE (for example) this can be used if you only allow some guests to make multiple payments.

Message tab:

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.

  • Plain text box (Using Message API)

Subject - enter the subject for your Guests Plain Text Message :- enter the Message text you wish to send to your guests include the payment link

https://beds24.com/bookpay.php?bookid=[BOOKID]

You can find extra options to add to the payment link if you want to refine the details

https://wiki.beds24.com/index.php/Category:Payments#Payment_Request

  • HTML Message (Send Email)

Edit Email Subject - enter the subject for your Guests Edit Email Text :- enter the Email text you wish to send to your guests include template variable [PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.


Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.

Create additional Auto Actions for each period you want to trigger

Create Auto Action 2 (and 3, 4, 5 - how many you need)

  • Trigger Time = +14 days (days you want to collect the payments)
  • Trigger Window = 1 day

The use the settings in the previous auto action to trigger the next auto action for your booking.

10.1.15 Send a Request to 'Capture' a Security deposit from your guests XX days before check-in - with Stripe

You want to capture a Security Deposit for bookings on the day before check-in from your guest.

Capture of the payment is only held by Stripe for 7 days, if the guest is staying longer you will need to send the request again.

You will need to create multiple emails to capture the payment multiple times for the same booking.


Trigger tab:

  • Trigger Event = Check-in
  • Trigger Time = -1 days
  • Trigger Window = 1 day
  • Booking Source = ALL (or select the booking source/Channel)
  • Status = All not cancelled

Message tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here, change the pay=100 to the value you require.

https://beds24.com/bookpay.php?bookid=[BOOKID]&g=st&capture=0&pay=100.

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain text box above. Template variables can be used see here

Booking info tab: (Optional)

  • Booking Info Code = SECDEPOSIT (for example)
  • Booking Info Text = Security deposit request sent.

10.1.16 Send an email to the guest email address when a payment FAILS at Stripe

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE

Message tab: Update details as appropriate

  • Send Message = Booking API and Email Smart: If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address.

If only a masked Email address is available the message sends via the channels API messaging systems if possible. If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email. Messages to the Email address entered in the field "Internal" are sent via Email.

  • Plain text box (Using Message API)

Subject - enter the subject for your Guests Plain Text Message :- enter the Message text you wish to send to your guests including the payment link

https://beds24.com/bookpay.php?bookid=[BOOKID]

You can find extra options to add to the payment link if you want to refine the details

https://wiki.beds24.com/index.php/Category:Payments#Payment_Request

  • HTML Message (Send Email)

Email Subject - enter the subject for your Guests Email Text :- enter the Email text you wish to send to your guests include template variable [PAYLINK] this creates a payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Check the template variables for other options.

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.

10.1.17 Send an Email in the guests language to an internal Email address

This uses a smart template variable. In this example we check whether the guest booked in French. If yes, then we send a French text. If no, we send an English text.

Trigger tab:

Time:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1

Booking Source:

  • Booking Source = All (for example)

Booking Conditions:

  • Booking Status = All Not Cancelled

Booking Fields:

  • Booking Field Contains - select "Language" in the next field enter: the short code for the language this Auto Action is for.

Message tab: Enter the message in the appropriate language under your default language.

  • Send Message = Internal Only
  • Internal Email Address = enter the email address this message should be sent to.
  • Email Subject - enter the subject for your Guests
  • HTML box - Email will be sent
  • Email Text :- Template variables can be used in the message. See here

10.1.18 Send SMS in a certain language (if it is the language of the booking) or a default language

This uses a smart template variable. In this example the auto action will trigger on Booking and for 1 day, we check whether the guest booked in French. If yes, then we send a French text. If no, we send an English text.

Trigger tab:

Set the rules to when this Auto Action should trigger.

Time:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1

Booking Source:

  • Booking Source = All (for example)

Booking Conditions:

  • Booking Status = All Not Cancelled


SMS tab:

  • Phone Number = [GUESTMOBILE]
  • SMS Message = [IF=:[GUESTLANGUAGE]:fr:French_text|English_text]

10.1.19 Send Remotelock/Lockstate, Nuki PIN or Chekin Link 2 days before Check-in (Self Checkin) - Select from the predefined template

Trigger tab:

Time:-

  • Trigger Event = Check-in
  • Trigger Time = -2 (the number of days before check-in you want to sent the code or link)
  • Trigger Window = 2

Booking Souce :-

  • Booking Source = All
  • Booking Status = Confirmed

Booking Conditions:-

  • Group bookings = Trigger all on master

Info Codes :-

  • Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL (select the appropriate Booking Info Code for the service you use)

Messaging tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Subject - enter the subject for your Guests - Your access code (your text)
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used see here

10.1.20 Send Pin code to guest, 2 days before Check-in (Self Checkin)

This auto action can be used if you have set a fixed PIN code in the Room Setup or using digits from the Booking id.

To setup the PIN code for each Room/Unit then go to (SETTINGS) > PROPERTIES > ROOMS > SETUP > UNIT NAMES, then in the unit names, you can add additional information including a pin code.

Example:

You have 2 units (100 and 101). Access Pin Code for 100 = 12345, for 101 - 34567

In "Unit name" enter: (Use (?) in the room setup for more details/options)

  • 100|12345
  • 101|34567

Trigger tab:

Time:-

  • Trigger Event = Check-in
  • Trigger Time = -2 (the number of days before check-in you want to sent the code or link)
  • Trigger Window = 2

Booking Souce :-

  • Booking Source = All
  • Booking Status = All but not cancelled

Booking Conditions:-

  • Group bookings = Trigger all on master

Messaging tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Subject - enter the subject for your Guests - Your access code (your text)
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [UNITNAME] and [UNITNAME:1] or [BOOKIDLAST5] - Last 5 digits of booking number. See the list of ALL template variables that can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [UNITNAME] and [UNITNAME:1] or [BOOKIDLAST5] - Last 5 digits of booking number. see the list of ALL template variables that can be used see here

10.1.21 Send Email to guests with check-in details 2 days before Check-in, booking paid/no outstanding balance

This auto action will be sent only when the Invoice Balance of the booking is zero. This can be used to ensure that the checkin details are only sent when the guest has completed the payments.

Trigger tab:

Time:-

  • Trigger Event = Check-in
  • Trigger Time = -2 (the number of days before check-in you want to sent the code or link)
  • Trigger Window = 2

Booking Source:-

  • Booking Source = All
  • Booking Status = All but not cancelled

Booking Conditions:-

  • Group bookings = Trigger all on master
  • Invoice Balance = Zero

Messaging tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Subject - enter the subject for your Guests - Your access code (your text)
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. This can include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used see here

  • HTML box - Email will be sent

Email Text :- Enter the text you wish to send to your guests this can include URLs. Include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used see here

10.1.22 Send Email to guests with check-in details 2 days before Check-in, Security Deposit Authorised at Stripe

This auto action will be sent only when the a payment has been 'authorised' at Stripe. This can be used to ensure that the checkin details are only sent when the guest has completed the Security Deposit Authorisation.

Trigger tab:

Time:-

  • Trigger Event = Check-in
  • Trigger Time = -2 (the number of days before check-in you want to sent the code or link)
  • Trigger Window = 2

Booking Source:-

  • Booking Source = All
  • Booking Status = All but not cancelled

Booking Conditions:-

  • Group bookings = Trigger all on master
  • Invoice Balance = Zero

Info codes :-

  • Any Booking Info Code = STRIPEAUTHORIZE

Messaging tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Subject - enter the subject for your Guests - Your access code (your text)
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. This can include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used see here

  • HTML box - Email will be sent

Email Text :- Enter the text you wish to send to your guests this can include URLs. Include any information that is important for the checkin of the guest, for example the Key code for the door, who to contact if there are any issues, template variables can be used, see the list of ALL template variables that can be used see here

10.1.23 Send Email to all current guest (Check-in)

Trigger tab:

Time:

  • Trigger Event = Check-in
  • Trigger Time = Immediate
  • Trigger Window = 14(the max number of days your guests can stay)

Booking Source:

  • Booking Source = All

Booking Conditions:

  • Group bookings = Trigger all on master
  • Booking Status = All but not cancelled

Info Codes:

  • Any Booking Info Code = CHECKIN
  • Exclude Booking Info Code = CHECKOUT

Messaging tab: For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used see here


It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.

10.1.24 Send invoice after check-out - PDF attachment - Select from the predefined template

You can send Invoice as an attachment to your Guests.

Setup your Invoice go to (SETTINGS) GUEST MANAGEMENT -> INVOICING

Trigger tab:

Time:

  • Trigger Event = Checkout
  • Trigger Time = Immediate +8hrs
  • Trigger Window = 1 day

Booking Source:

  • Booking Source = All (or select the appropriate channel/Direct)

Booking Conditions:

  • Group bookings = Trigger all on master
  • Booking Status = Confirmed

Info Codes:

  • Any Booking Info Code = CHECKOUT

Messaging tab:

  • Send Email = Guest email - (or one of the other options)
  • Attachment = Invoice Template 1
  • Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used see here

It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkout to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.

If you send Emails with pdf attachment (invoice, booking template) to Alias-Email addresses created by channels the channel might block the attachment so it is not delivered to the guest. Ask your channel about their policy regarding this.

Other files can not be attached. We recommend you use a link to a file you upload to your web site.

10.1.25 Send Email with Booking Registration Form - PDF attachment

You can send Booking Template attachments to your Guests.

Setup your Booking Template, go to (SETTINGS) GUEST MANAGEMENT -> BOOKING TEMPLATES

Trigger tab:

Time:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1 day

Booking Source:

  • Booking Source = All (or select the appropriate channel/Direct)

Booking Conditions:

  • Group bookings = Trigger all on master
  • Booking Status = All but not cancelled

Messaging tab:

  • Send Message = Guest API/Smart Email (or one of the other options)

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Attachment = Select Booking Template from the drop down list.
  • Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Template variables can be used see here

It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkout to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.

If you send Emails with pdf attachment (invoice, booking template) to Alias-Email addresses created by channels the channel might block the attachment so it is not delivered to the guest. Ask your channel about their policy regarding this.

Other files can not be attached. We recommend you use a link to a file you upload to your web site.

10.1.26 Send Email after the cleaner has cleaned the room

To send an automated Email to the guest then they can check you/the cleaner have to add a unit status to the room when it is ready. In this example we used the unit status clean

Trigger tab:

Time:

  • Trigger Event = Checkin
  • Trigger Time = Immediate
  • Trigger Window = 1

Booking Source:

  • Booking Source = All

Booking Conditions

  • Group bookings = Trigger all on master
  • Booking Status = All but not cancelled

Booking Fields:

  • Template Variable = [UNITSTATUS1] Contains = clean

Messaging tab:

  • Send Email = Guest API/Smart Email (or one of the other options)

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests. Template variables can be used see here

  • HTML box - Email will be sent

Email Text :- It is possible to use the same details as in the Plain Text box above. Template variables can be used see here

  • Attachment :- if you want to send a Booking/Invoice template you can select from the drop down list.

Other files can not be attached. We recommend you use a link to a file you upload to your web site.

10.1.27 Send Email to your guest - Upselling additional nights - nights available after checkout

To send an automated Email to the guest confirming that it is possible to extend their stay.

This example uses fixed values that you have entered into (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.

Trigger Tab :

Time:

  • Trigger Event = Checkin (depending on when you want to notify the guest)
  • Trigger Time = -2 days (depending on when you want to notify the guest, in this example 2 days before arrival)
  • Trigger Window = 2

Booking Source:

  • Booking Source = All

Booking Conditions:

  • Group bookings = Trigger all on master
  • Booking Status = All but not cancelled

Booking Fields:

  • Template Variables = [IFBETWEEN:[TURNOVERDAYS]:0:3:yes|no|no] equal yes

This template variable tests if there is 3 days between the guest booking and the next booking.

Message tab:

For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

  • Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Email Subject - enter the subject for your Guests
  • Plain text box - will send to channels using Message API, enter the text you wish to send to your guests. Template variables can be used see here

[IF<=:[TURNOVERDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [TURNOVERDAYS] extra night(s)|].

We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.


  • HTML box - Email will be sent, enter the text you wish to send to your guests. Template variables can be used see here

[IF<=:[TURNOVERDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [TURNOVERDAYS] extra night(s)|].

We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.

Booking Info Tab : Optional

  • Booking info code = EXTRANIGHTS
  • Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night

10.1.28 Send Email to your guest - Upselling additional nights - nights available before checkin

To send an automated Email to the guest confirming that it is possible to extend their stay.

This example uses fixed values that you have entered into (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.

Trigger Tab :-

Time:

  • Trigger Event = Checkin (depending on when you want to notify the guest)
  • Trigger Time = -2 days (depending on when you want to notify the guest, in this example 2 days before arrival)
  • Trigger Window = 2

Booking Source:

  • Booking Source = All

Booking Conditions:

  • Group bookings = Trigger all on master
  • Booking Status = All but not cancelled

Booking Fields:

  • Template Variables = [IFBETWEEN:[VACANTDAYS]:0:3:yes|no|no] equal yes

This template variable tests if there is upto 3 days from previous checkout to check in of current booking.

Messaging tab :-

  • Send Message = Guest API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

If no connection to a messaging system is available the message will send to the Email address from the "Mail & Actions" tab of the Email.

  • Subject = Enter the appropriate details
  • Plain Text Box = Your text, using the template variables to modify the specific text in the booking.

[IF<=:[VACANTDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [VACANTDAYS] extra night(s)|].

We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.

  • HTML Box

[IF<=:[VACANTDAYS]:3:Your apartment ([ROOMNAME]), which you booked for [NUMNIGHT] nights from [FIRSTNIGHTSHORT] to [LEAVINGDAYSHORT] is currently available for up to [VACANTDAYS] extra night(s)|].

We are very happy to offer you to extend your stay a [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night. If you would like to extend your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EXTRANIGHTS’ for the special Price.

Booking Info Tab :- Optional

  • Booking info code = EXTRANIGHTS,
  • Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] per extra night

10.1.29 Send Email to your guest - Offering Early Checkin

To send an automated Email to the guest confirming that it is possible to have an Early Checkin as room is available the day of before arrival.

This example uses fixed values that you have entered into (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.

Trigger Tab :-

  • Trigger Event = Checkin (depending on when you want to notify the guest)
  • Trigger Time = -2 days (depending on when you want to notify the guest, in this example 2 days before arrival)
  • Trigger Window = 2
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Group bookings = Trigger all on master
  • Template Variables = [IF>:[VACANTDAYS]:1:yes|no] equal yes

This template variable tests if there is 1 day between the guest booking and the next booking.

Message tab :-

  • Send Email = Guest API/Smart Email (or one of the other options)
  • EMail Subject = Enter the appropriate details
  • Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)

Dear, [GUESTNAME],

We are very happy to offer you 'Early Check-in' at [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK].

If you would like checkin early for your stay then please send an email to our Reservations team [PROPERTYEMAIL] confirming the number of nights you would like to stay and provide your Booking Reservation Number [BOOKID] and Offer ‘EARLYARRIVAL’ for the special Price. Best regards,

[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME] [PROPERTYNAME]  [PROPERTYADDRESS], [PROPERTYCITY], [PROPERTYPOSTCODE], [PROPERTYSTATE], [PROPERTYCOUNTRY].   Email :-[PROPERTYEMAIL] Website :- [PROPERTYWEB]

Booking Info Tab :- Optional

  • Booking info code = EARLYARRIVAL,
  • Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] Early Checkin

10.1.30 Send Email to your guest - Offering Late Checkout

To send an automated Email to the guest confirming that it is possible to have a Late Checkout as room is available the day of departure.

This example uses fixed values that you have entered into (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.

Trigger Tab :-

  • Trigger Event = Checkout
  • Trigger Time = -1 days (depending on when you want to notify the guest, in this example 2 days before arrival)
  • Trigger Window = 1
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Group bookings = Trigger all on master
  • Template Variables = [IF>:[TURNOVERDAYS]:1:yes|no] equal yes

This template variable tests if there is 1 day between the guest booking and the next booking.

Message tab :-

  • Send Email = Guest API/Smart Email (or one of the other options)
  • EMail Subject = Enter the appropriate details
  • Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)

Dear, [GUESTNAME],

We are very happy to offer you 'Late Check-out' at [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK].

If you would like a late checkout, then please send an email to our Reservations team [PROPERTYEMAIL] confirming you would like the Late Checkout, provide your Booking Reservation Number [BOOKID] and Offer ‘LATECHECKOUT’ for the special Price.

Best regards,

[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME] [PROPERTYNAME]  [PROPERTYADDRESS], [PROPERTYCITY], [PROPERTYPOSTCODE], [PROPERTYSTATE], [PROPERTYCOUNTRY].   Email :-[PROPERTYEMAIL] Website :- [PROPERTYWEB]

Booking Info Tab :- Optional

  • Booking info code = LATCHECKOUT,
  • Booking Info Description = Upsell email sent [CURRENTDATE] :[ROOMTEMPLATE3][PROPERTYCURRENCYBACK] Late Checkout

10.1.31 Send Email to your guest - Offering Late Checkout Only on a Sunday when there is no new arrival

To send an automated Email to the guest confirming that it is possible to have a Late checkout on Sundays as the room is available on the day of departure.

This auto action will create a new booking for the date of departure, closing the calendar to any other bookings.

The URL link in the message tab, will send the guest to your guest booking page with set conditions, the leaving date of the existing booking, the room id of the existing booking and the Offer you have created for the LateCheckout.

This example uses fixed values that you have entered into (SETTINGS) > PROPERTIES > ROOMS > SETUP > ROOM TEMPLATES and standard Template Variables set in the Property/Rooms, useful way to utilise the template variables and different values rather than duplicating auto actions.

Step 1: Create a new offer in (SETTINGS) > PROPERTIES > OFFERS

  • Name = Latecheckout
  • Enable = Only if Available
  • Booking Type = Confirmed with Deposit 2 - via payment gateway

Step 2: Create a Rate or Daily Price, PRICES

  • Guests = Max Occupancy
  • Max Stay = 1
  • Offer = select the offer number as created in the above step.

If you are using Rates, select 'Rate allowed' = Sunday, untick all the other days. Channel Tab, untick all channels, leave only 'beds24.com' for your booking page.

If using Daily Prices, then go to Calendar, and set the price and date range, then only Sunday, untick all the other days. Enable list, untick all channels, leave only 'beds24.com' for your booking page.

Step 3: Create the custom question for the booking id

Go to (SETTINGS) > PROPERTIES > BOOKING QUESTIONS > CUSTOM QUESTIONS and create a question

  • Question = Booking Id
  • Single Line field
  • Optional

Step 4: Create the Auto Action

Trigger Tab :-

  • Trigger Event = Checkout
  • Trigger Time = -1 days (depending on when you want to notify the guest, in this example 2 days before arrival)
  • Trigger Window = 1
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Between Booking and Check in = 2 and 999 (to stop the auto action triggering on the new booking)
  • Group bookings = Trigger all on master
  • Template Variables = [IF=:[LEAVINGDAY:{%a}]:Sun:[IF>=^[TURNOVERDAYS]^1^yes~no]|] equal yes

This template variable tests if the departure day is a Sunday and there is at least 1 day between the existing guest booking and the next booking.

Message tab :-

  • Send Email = Guest API/Smart Email (or one of the other options)
  • EMail Subject = Enter the appropriate details
  • Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)

Dear, [GUESTNAME],

We are very happy to offer you 'Late Check-out' at [PROPERTYNAME] at the exceptional rate of [ROOMTEMPLATE3][PROPERTYCURRENCYBACK].

If you would like a late checkout, please use this link to make the booking and payment.

https://beds24.com/booking2.php?propid=[PROPERTYID]&checkin_hide=[LEAVINGDAYYYYY-MM-DD]&br5-[ROOMID]=Book

The details in the URL, will direct the guest to make a new booking in the existing room with the check-in date = leaving date and for Offer 7 &br-7 (offer created in Step 1 above)

Enter your Booking Reservation Number [BOOKID] into the Booking id box on the booking page. Best regards,

[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME]

Email :-[PROPERTYEMAIL] Website :- [PROPERTYWEB]

Booking Info Tab :- Optional

  • Booking info code = LATCHECKOUT,
  • Booking Info Description = Upsell email sent [CURRENTDATE]: Late Checkout

10.1.32 Send Email to your guest - On a Wednesday (Cleaner is due/Rubbish Collection is due)

To send an automated Email to the guest reminding them that there is an event on a specific day of the week, for instance, the cleaner is due on Wednesday mornings, or the bin collection is due on Thursday mornings.

You will need to check for the day of the week. If the booking is for more than 1 week, you will need multiple auto actions as an email will only be sent once, it is not possible to trigger multiple times.

Step 1: Create the Auto Action

Trigger Tab :-

  • Trigger Event = Checkin
  • Trigger Time = Immediate
  • Trigger Window = 8 days
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Template Variables = [IF=:[CURRENTDATE:{%u}]:3:yes|no] equal yes
%u 	ISO-8601 numeric representation of the day of the week 	1 (for Monday) through 7 (for Sunday)

This template variable tests if the current day is a Wednesday.

Message tab :-

  • Send Email = Guest API/Smart Email (or one of the other options)
  • EMail Subject = Enter the appropriate details
  • Email Text = Your text, using the template variables to modify the specific text in the booking. Enter the text in both Plain text Box (Messaging API) and HTML Box (Emails)

Dear, [GUESTNAME],

Hope you are enjoying your holiday at [PROPERTYNAME].

We would like to remind you that the cleaner is due to visit you on Thursday morning between 10am and 12am.

Best regards,

[PROPERTYCONTACTFIRSTNAME] [PROPERTYCONTACTLASTNAME]

Email :-[PROPERTYEMAIL] Website :- [PROPERTYWEB]

Booking Info Tab :- Optional

  • Booking Info code = CLEANWED1
  • Booking Info text = Reminder that cleaning is due on the first Thursday of their stay.
This can be used to trigger the next auto action if the duration of their holiday is more than 1 week. Include the Booking Info code in the Trigger tab of the next auto action. 

10.2 Send an email to the Owner/Internal email address

10.2.1 Send an email to the Owner/Internal email address when a payment FAILS at Stripe

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE

Messaging tab:

  • Send Message = Internal
  • Internal Email Address = enter the email address to receive the notification
  • Subject = Failed Stripe Payment
  • HTML Box = Enter the text to be sent, you can use template variables in this message, for example

[BOOKID] - booking reference number [GUESTNAMES] - name of all guests in the booking on the "summary" tab of the booking [FIRSTNIGHT] [LASTNIGHT]

Booking tab: (optional)

  • Execution = One time only
  • Flag Text = Stripe Payment Failed
  • Flag Colour - choose the flag colour

10.2.2 Send an email to the Owner/Internal email address when a guest completes a Payment Authorisation at Stripe

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Booking Info Code = STRIPEAUTHORIZE

Messaging tab:

  • Send Message = Internal
  • Internal Email Address = enter the email address to receive the notification
  • Subject = Stripe Payment Authorisation
  • HTML Box = Enter the text to be sent, you can use template variables in this message, for example

[BOOKID] - booking reference number [GUESTNAMES] - name of all guests in the booking on the "summary" tab of the booking [FIRSTNIGHT] [LASTNIGHT]

Booking tab: (optional)

  • Execution = One time only
  • Flag Text = Stripe Authorised
  • Flag Colour - choose the flag colour

10.2.3 Send an email to the Owner/Internal email address for a new booking

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1 day
  • Booking Source = All
  • Booking Status = All but not cancelled

Messaging tab:

  • Send Message = Internal
  • Internal Email Address = enter the email address to receive the notification
  • Subject = New Booking
  • HTML Box = Enter the text to be sent, you can use template variables in this message, for example

[BOOKID] - booking reference number [GUESTNAMES] - name of all guests in the booking on the "summary" tab of the booking [FIRSTNIGHT] [LASTNIGHT]

10.3 Booking Info Codes

10.3.1 Add CHECKIN Booking info code to bookings

If you need to use the Booking info code CHECKIN/CHECKOUT for reporting/other auto actions, you can set the Booking info code rather than use the Current guest module in the dashboard.

Trigger tab:

  • Trigger Event = Check-in
  • Trigger Time = Immediate
  • Trigger Window = 1 day
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Group bookings = Trigger all on master

Booking Info tab:

  • Booking Info Code = CHECKIN
  • Booking Info Text = Auto Checkin

10.3.2 Add CHECKOUT Booking info code to bookings

If you need to use the Booking info code CHECKIN/CHECKOUT for reporting/other auto actions, you can set the Booking info code rather than use the Current guest module in the dashboard.

Trigger tab:

  • Trigger Event = Check-out
  • Trigger Time = Immediate
  • Trigger Window = 1 day
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Group bookings = Trigger all on master

Booking Info tab:

  • Booking Info Code = CHECKOUT
  • Booking Info Text = Auto Checkout

10.3.3 Group check-in - Select from predefined templates

This requires the master booking to be checked-in via the check-in function.

Trigger tab:

  • Trigger Event = Checkin
  • Trigger Time = immediate
  • Time Window = 1 day

Booking conditions:

  • Booking Source = All
  • Booking Status = All but not cancelled
  • Group bookings" = Trigger all on master if group
  • Info Code = CHECKIN

Booking info tab :

  • Booking Info Code = CHECKIN
  • Booking Info Text = Group checked in

10.3.4 Identify Repeat Guest

This requires you to use the Guest database.

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = immediately
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Group bookings" = Trigger all on master
  • Template Variable = [GUESTSID1] greater than 0

Booking info tab :

  • Info Code = REPEAT

10.3.5 Identify bookings with Custom Question ticked/unticked

If you have a custom question with a 'Tick box' for example, they want a late checkin.

Setup the custom question in (SETTINGS) PROPERTIES -> BOOKING QUESTIONS -> CUSTOM QUESTIONS -> Custom question 1, set with TYPE = Tick Box.

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Group bookings" = Trigger all on master
  • Template Variable = [GUESTCUSTOMQ1] equals ticked (or) not ticked

Booking info tab :

  • Info Code = LATECHECKIN

10.4 Add invoice items to a booking

10.4.1 Add a fee to all bookings from a channel

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Booking Source = Expedia (for example)

Invoice tab:

  • Add Invoice Item = Add new
  • Type = Amount
  • Description = Cleaning fee (for example) - Template variables can be used.
  • Amount = 50 (for example - the amount of your cleaning fee)
  • per = Room
  • Period = one time
  • VAT = 19% (for example - enter the VAT amount if applicable)

The fee will be added the next time the auto actions run.

10.4.2 Add a fee (Penalty) to all bookings with an Outstanding Balance

You want to add a 2.2% fee to all bookings if there is an outstanding balance 2 days prior to checkin.

Trigger tab:

Time :

  • Trigger Event = Checkin
  • Trigger Time = -2 days
  • Trigger Window = 2 days

Booking Conditions:

  • Status = All not Cancelled
  • Invoice Balance = Not Zero

Invoice tab:

  • Type = Amount
  • Description = Payment Fee||[INVOICEBALANCE:2.2%]
  • Amount = 0 (leave as 0 so the value is set from the calculation in Description field)
  • Per = Room
  • Period = one time
  • VAT = 19% (for example - enter the VAT amount if applicable)

The fee will be added the next time the auto actions run.

10.4.3 Add a negative value to Direct bookings for Stripe Charges

You want to add the Stripe fee to all Direct bookings to show total value of booking, i.e. if you want to show the booking value. In this example the Stripe charge will be added as a negative figure.

Trigger tab:

Time :

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1 day

Booking Conditions:

  • Status = All not Cancelled

Booking Source:

  • Booking Source = Direct

Invoice tab:

  • Type = Amount
  • Description = Stripe Fee||[INVOICECHARGESNUM:-3%]
  • Amount = 0 (leave as 0 so the value is set from the calculation in the Description field)
  • Per = Room
  • Period = one time
  • VAT = 19% (for example - enter the VAT amount if applicable)

The fee/charge will be added the next time the auto actions run.

10.5 Modify description/values of an existing invoice item in a booking

10.5.1 Update the Description field of a charge/invoice item

In some cases Channel bookings have different descriptions for the same charge item - i.e. Cleaning, update the description field in the invoice item so they all match, using the format (findthisinvoicedescription^replacewiththisdescription)

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Booking Source = Expedia (for example)

Invoice tab:

  • Add Invoice Item = Update Only
  • Type = Change Description
  • Description = Cleaning^Cleaning Service Fee
  • Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)


10.5.2 Update all values of a charge/invoice item

You need to change the charges in bookings due to an update in your prices. Tourist Tax (for example), update the description field and value using the format (findthisinvoicedescription^replacewiththisdescription)

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Time Window = 365
  • Check In From = Select the first date of the Summer Season
  • Check In To = Select the last date of the Summer Season
  • Booking Source = Expedia (for example)

Invoice tab:

  • Add Invoice Item = Update Only
  • Type = Change All
  • Description = Tourist Tax^Tourist Tax - Summer season 2022 (for example)
  • Amount = 0.75
  • Per = Per Person
  • Period = One time
  • Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)


10.6 Payments/Pending Payments

10.6.1 Add a pending payment

Trigger tab:

  • Trigger Event = Booking or Booking (but not after Check-in)
  • Trigger Time = set the time you want to collect the payment
  • Booking Source =All (for example, you can also set different rules for different channels)
  • Group Booking Trigger = Trigger only Master (this will trigger on individual bookings and Master booking if a group)

Booking Info tab: Optional Add a booking info tab for information and reporting

  • Flag Text = PendingPayment (for example)
  • Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Booking tab: Optional

  • Booking Info Code = PENDPAY
  • Booking Info Text = Pending payment added

Invoice tab:

  • Payment Type = select on what the payment is calculated (Percent of Balance due OR Group balance if you receive Group bookings)
  • Description = the text you will see in the "Charges and Payments" tab
  • Status = if you use the status function add the status you want to apply to the pending payment (optional)
  • Amount = enter the amount or percentage you want to collect
  • Payment Rule = use auto or manual - if you have set up payment rules in (SETTINGS) GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here
  • Payment Due = Set when the payment is due


Create a Payment Rule to collect a payments when bookings are not cancelled.

Go to Settings > Payments > Payment Rules

Payment Rule :

Name = Enter your title - Not Cancelled (for example) Action = Auto

Payment Trigger :

  • Booking Status = All not cancelled
  • Any Booking Info Code = optional
  • All Booking Info Codes = optional
  • Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

  • Capture = Yes - immediately charged (Capture=Yes)
  • Add info code on success = add a Booking Info item to the booking on success
  • Add info code on failure = add a Booking Info item to the booking on failure

10.6.2 Add a pending payment - Set the Security Deposit value based on the price of the booking, using a calculation

Trigger tab:

  • Trigger Event = Booking or Booking (but not after Check-in)
  • Trigger Time = set the time you want to collect the payment
  • Booking Source =All (for example, you can also set different rules for different channels)

Booking tab: Optional

  • Flag Text = PendingPayment (for example)
  • Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Booking Info tab: Optional Add a booking info tab for information and reporting

  • Booking Info Code = PENDPAY
  • Booking Info Text = Pending payment added

Invoice tab:

  • Payment Type = fixed value
  • Description = Security Deposit||[IF<=:[INVOICEFIRSTITEMNUM]:800:200|[INVOICEFIRSTITEMNUM][/.0]4]

(Security Deposit is the description, then 2 | symbol, then the calculation for the 'Amount' to be set.)

This calculation, tests if the first invoice item value (usually the Accommodation value) is greater than or = 800 if so set the Security Deposit Amount = 1 quarter of the first invoice item value, otherwise set = 200.

Tip A price value for the invoice item can be specified after a second pipe (|) symbol, this can be used to calculate a price using template variables. If the price value in the description field is zero or absent, the numeric value from the amount field will be used.

  • Status = if you use the status function add the status you want to apply to the pending payment (optional)
  • Amount = 0
  • Payment Rule = use auto or manual - if you have set up payment rules in (SETTINGS) Payments > Payment Rules they will be available here
  • Payment Due = Set when the payment is due


Create a Payment Rule to collect a payments when bookings are not cancelled.

Go to Settings > Payments > Payment Rules

Payment Rule :

Name = Enter your title - Not Cancelled (for example) Action = Auto

Payment Trigger :

  • Booking Status = All not cancelled
  • Any Booking Info Code = optional
  • All Booking Info Codes = optional
  • Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

  • Capture = Yes - immediately charged (Capture=Yes)
  • Add info code on success = add a Booking Info item to the booking on success
  • Add info code on failure = add a Booking Info item to the booking on failure

10.6.3 Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)

'Create a Payment Rule (Optional)'

Standard payment rules in the system are Auto & Manual, you can create additional rules for the collection of outstanding payments, you can control the collection of payments if the booking status is changed, for example the booking is cancelled before the final payment is due to be collected.

Go to (SETTINGS) PAYMENTS > PAYMENT RULES

Create a Payment Rule to collect payments if bookings are not cancelled.

Click Create New Payment Rule :

Payment Rule:

  • Name = Enter your title - Not Cancelled (for example)
  • Action = Auto

Payment Trigger :

  • Booking Status = All not cancelled
  • Any Booking Info Code (optional)
  • All Booking Info Codes (optional)
  • Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

  • Funding Source = Guest card only
  • Payment value adjustment = Limit to group booking balance
  • Capture = Yes - immediately charged (Capture=Yes)
  • Add info code on success = add a Booking Info item to the booking on success
  • Add info code on failure = add a Booking Info item to the booking on failure

Prevent Auto Payment :

  • Prevent payment if booking status = Cancelled
  • Prevent payment after check-out (days) = 7 (default)
  • Prevent payment action = Set Manual


Create Auto Actions

Collect the outstanding balance for bookings created via your booking page.

Go to (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS and click Create New Action to create them.

Collect outstanding balance for direct bookings

Trigger tab:

  • Time
    • Trigger Event = Checkin
    • Trigger Time = -3 days (set the time you want to collect the payment)
    • Time Window = 3 days (set this to the same number (positive) as Trigger time.
  • Booking Source
    • Booking Source = Direct. You can have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
  • Booking Conditions
    • Group Booking Trigger = Trigger only Master
    • Status = All not cancelled
    • Invoice Balance= Not Zero (can be used to refine the auto action being triggered)

Booking tab: Optional

  • Flag Text = Pending payment added (for example)
  • Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Booking Info tab: Optional, for information and reporting

  • Booking Info Code = BALANCE (for example enter the value - use one word only)
  • Booking Info Text = Enter the description/text to show in for the Booking Info Code.

Invoice tab:

ONLY use Payment Type =‘ Percent of Group balance due’ if you selected Trigger tab > Booking Conditions > Group Booking Trigger = Trigger Only Master.
  • Add a Pending Payment to the booking
    • Payment Type = Percent of Group Balance due (select on what the payment is calculated)
    • Description = the text you will see in the "Charges and Payments" tab
    • Status = if you use the status function add the status you want to apply to the pending payment (optional)
    • Amount = 100 (this will be 100% of the outstanding group balance)
    • Payment Rule = Not Cancelled - See Step 4 above (if you have set up payment rules in (SETTINGS) PAYMENTS ->PAYMENT RULES they will be available here)
    • Payment Due = Trigger date
    • Payment time = set the time to collect payment
    • Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.

10.6.4 'Capture' a Security Deposit when Credit card is collected at time of booking.

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = immediate
  • Booking Source =All (for example, you can also set different rules for different channels)

Info Codes: Any Booking Info Code = CARDTOSTRIPE

Invoice tab:

  • Payment Type = Fixed amount
  • Description = Security Deposit (the text you will see in the "Charges and Payments" tab)
  • Status = if you use the status function add the status you want to apply to the pending payment (optional)
  • Amount = 100 (balance is full price so 100% of the balance)
  • Payment Rule = Security Deposit (Create a Payment Rule, see below)
  • Payment Due = check in


Automatic collection is only available for customer who use Stripe.

Create a Payment Rule to 'Capture' a payment only. Captured payments will only be valid for 7 days, then it will expire, if the booking is for a longer period, then you can create a second Capture, you will need to create another auto action for this.

Go to (SETTINGS) PAYMENTS > PAYMENT RULES

Payment Rule :

  • Name = Enter your title - Security Deposit (for example)
  • Action = Auto

Payment Trigger :

  • Booking Status = select from the drop down list
  • Any Booking Info Code = optional
  • All Booking Info Codes = optional
  • Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

  • Capture = Yes/No - immediately charged (Capture=Yes), if you want to make sure that the amount is available for later capture (Capture=No)
  • Add info code on success = add a Booking Info item to the booking on success
  • Add info code on failure = add a Booking Info item to the booking on failure

10.6.5 Apply an info code and and/or icon when a payment was made

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Invoice Balance = Any Payment made

Booking Info tab:

  • Booking Info Code : Enter the preset code for the icon or info code which you have created in (SETTINGS) ACCOUNT->PREFERENCES.
  • Booking Info Text : Enter the text you wish to show

Process Template Variables : When created

10.6.6 Automatically apply invoice number at check-out - Select from predefined templates

Trigger tab:

  • Trigger Event = Check-out
  • Trigger Time = Immediate
  • Time window = 1 day

Booking Conditions:

  • Status = Confirmed

Info Codes:

  • Any Booking Info Code = CHECKOUT (optional only if you use the check-out function)

Invoice tab:

  • Assign Invoice Number = yes

10.6.7 Using Pending Payments as a Payment Reminder

Trigger tab:

  • Trigger Event = Booking or Booking (but not after Check-in)
  • Trigger Time = set the time you want to add the pending payment to the booking
  • Booking Source =All (for example, you can also set different rules for different channels)

Booking Info tab:

  • Optional, add a booking info tab for information and reporting

Booking tab: Optional

  • Flag Text = PaymentDue1 (for example), set multiple if multiple payments are required.
  • Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Invoice tab:

  • Payment Type = select on what the payment is calculated (Percent of Balance due)
  • Description = the text you will see in the "Charges and Payments" tab
  • Status = if you use the status function add the status you want to apply to the pending payment (optional)
  • Amount = enter the amount or percentage you want to collect
  • Payment Rule = Manual - if you have set up payment rules in (SETTINGS) GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here
  • Payment Due = Set when the payment is due

The Pending Payment Report is available in Bookings > Pending Payments. This report can be used to see outstanding pending payments, this can be used to see all outstanding payments, when payment gateways other than Stripe are used, the Pending Payments report can be used to see outstanding payments and a checklist for bank transfers.

10.6.8 Test if Stripe Authorisation has expired and you need to trigger a new authorisation

Stripe authorisations are dependent on a number of factors including your account type, credit card provider, Stripe rules and the guest bank provider.

If you have bookings that are longer than the authorisation period, you will need to create multiple authorisations. You can use the details below in an auto action to test the date/value of the text/description of the Booking info code = 'STRIPEAUTHORIZE'

For example you have a booking that is for 14 nights, but the authorisation period is 7 days.

Trigger tab:

  • Trigger Event = Checkin
  • Trigger Time = + 7 days
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled

Booking Conditions

  • Group Booking Trigger = Trigger only Master
  • Status = All not cancelled
  • Invoice Balance= Any
  • Minimum Stay = 7
  • Maximum Stay = 14

Info Codes

  • Any booking info code = CARDTOSTRIPE, STRIPEAUTHORIZE
  • Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT

If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.

Booking Fields

  • Template Variable = [IF<^[AUTHORIZEUNTIL{%Y-%m-%d}]^[CURRENTDATEYYYY-MM-DD]^yes~no] equal yes

The entry in the info tab of the booking will typically be

STRIPEAUTHORIZE Authorize 1500.00 EUR until 2024-08-14........

Check the substring numbers for your specific bookings, the date starts on the 28th char as the amount is 1500.00

Booking tab: Optional

  • Flag Text = Security Deposit Pending Payment (for example)
  • Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.

  • Booking Info Code - REFDEPPP (for example)
  • Booking Info Text - Refundable Security Deposit pending payment

Invoice tab:

  • Add a Pending Payment to the booking
  • Payment Type = Fixed amount
  • Description = the text you will see in the "Charges and Payments" tab
  • Status = if you use the status function add the status you want to apply to the pending payment (optional)
  • Amount = 1500 (enter the value you want to authorise on the guest credit card )
  • Payment Rule = Security Deposit (use the payment rule)
  • Payment Due = Trigger date
  • Payment time = set the time to collect payment
  • Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.

If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.

10.7 Booking Flags/Colours

10.7.1 Apply a flag when a booking is cancelled

Trigger tab

  • Trigger Event = Booking
  • Trigger Time = 1 Hour
  • Trigger Window = 365 days
  • Booking Status = Cancelled

Booking tab:

  • Execution = One time only
  • Booking Status = No Change
  • Flag text = (enter the text you require)
  • Flag Colour = 999999 default cancel colour - (Set as required)

10.7.2 Apply a flag for a bookings from a channel which have breakfast included

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Booking Source = Booking.com (for example)
  • Booking Field Contains - select "API Message" in the next field enter: meal_plan=Breakfast (or Extra Breakfast - use the text the channel uses)

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.

10.7.3 Apply a flag for a bookings which has BREAKFAST as a charge item

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Booking Source = Booking.com (for example)
  • Template Variable = [IF>:[INVOICEITEMBYDESC:Breakfast]:0:yes|no] (Text for Breakfast has to match EXACTLY what is in the booking item Uppercase/Lowercase/Proper)
  • Select 'equal' from the selection box
  • yes (needs to be exactly the same text/upper/lowercase, as in the equation)

Booking tab:

  • Execution = One time only
  • Flag Text = Breakfast
  • Flag Colour - choose the flag colour

Booking Info tab:

  • Booking Info Code = BREAKFAST
  • Booking Info Description = Breakfast included

10.7.4 Apply a flag when deposit was made prior to Check-in

Trigger tab:

  • Trigger Event = Check-in
  • Trigger Time = -365 (for example : must be a negative value and the same as the value in Trigger window)
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All but not cancelled
  • Invoice Balance = Any Payment made

Message tab:

  • Send Email : select appropriate option
  • Enter : Subject and Email content

Booking tab: (optional)

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking info tab : (optional)

  • Booking Info Code : DEPOSITPAID (for example)
  • Booking Info Text : additional text if required.

Setting details with the Booking tab and Booking info tab allows you to trigger additional (follow on) Auto Actions and Reports.

10.7.5 Apply a flag when booking is fully paid

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All not cancelled
  • Invoice Balance = ZERO

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

10.7.6 Apply a flag/colour for a booking coming from a certain channel - Select from the predefined template

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Booking Source = Booking.com (for example)

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the email.

10.7.7 Apply a flag when NO payment is made - Select from the predefined template

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 1 day

Booking Source:

  • Booking Source = All

Booking Conditions:

  • Booking Status = All not cancelled
  • Invoice Balance = No payment made

Booking tab:

  • Execution = One time only
  • Flag Text = Not Paid
  • Flag Colour = fee0dd

10.7.8 Apply a flag when a payment was made

Also see Example : " Apply a flag when deposit was made prior to Check-in AND/OR Apply a flag when booking is fully paid".

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Trigger Window = 365
  • Booking Source = All
  • Booking Status = All not cancelled
  • Invoice Balance = Any Payment made

Booking tab:

  • Execution = One time only
  • Flag Text = The text you want to display
  • Flag Colour - choose the flag colour

10.7.9 Apply a flag when a payment FAILS at Stripe - Select from predefined template

Trigger tab:

  • Trigger Event = Booking (but not after check-in)
  • Trigger Time = Immediate
  • Trigger Window = 999

Booking Source:

  • Booking Source = All
  • Booking Status = All but not cancelled
  • Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE

Booking tab:

  • Execution = One time only
  • Flag Text = Stripe Payment Failed
  • Flag Colour - fee0dd

10.7.10 Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe

Go to Settings > Channel Manager > Preferences and set Auto report failed cards = Yes

Trigger tab:

  • Trigger Event = Booking (but not after checkout)
  • Trigger Time = Immediate
  • Trigger Window = 999

Booking Source:

  • Booking Source = Booking.com

Booking Conditions:

  • Booking Status = All not cancelled
  • Booking Info Code = BOOKINGCOMCARD

Booking tab:

  • Execution = One time only
  • Flag Text = Failed CC reported to Booking.com
  • Flag Colour - choose the flag colour

10.8 Status changes

10.8.1 Change the status of all "Request" bookings to "Cancelled" after three days

Trigger tab

  • Trigger Event = Booking
  • Trigger Time = 3 days
  • Booking Status = Request

Booking tab:

  • Execution = One time only
  • Booking Status = Cancelled

10.8.2 Change the status of Airbnb "Inquiry" bookings to "Cancelled" after three days

Trigger tab

  • Trigger Event = Booking
  • Trigger Time = 3 days
  • Booking Status = Inquiry
  • Booking Source = Airbnb

Booking tab:

  • Execution = One time only
  • Booking Status = Cancelled

10.8.3 Change the status of all bookings which have been imported from Ical to "Request"

Trigger tab:

  • Trigger Event = Booking
  • Trigger Time = Immediate
  • Booking Source = Ical Import (1, 2, 3)

Booking tab:

  • Execution = One time only
  • Booking Status = Request

Booking changes are applied before the mail is sent.

10.8.4 Change Room Unit Status when guest checks out

Trigger tab

  • Trigger Event = Check-out
  • Trigger Time = Immediate
  • Trigger Window = 1 day
  • Booking Status = All but not cancelled
  • Any Booking Info Code = CHECKOUT

Booking tab:

  • Execution = One time only
  • Change Room Unit Status = Select the option

It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.

10.9 API/Webhook

10.9.1 Use API/Webhook to write to the field 'Message'

You can use a webhook in conjunction with the API JSON function setBooking to write to any field in the booking. First you have to configure access to the API:

You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.
API key:
  • (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS "API Key 1"
  • API Key = my_very_secret_api_key
  • API Key Access = allow any IP
  • IP Whitelist = [leave empty]
  • Allow Writes = Yes
  • Property Access = Owned by this account only
  • Property key:
  • (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX

Set the triggers you need, for example:

Booking Field Contains: Message = XXX

Set the webhook like this:

  • URL = https://api.beds24.com/json/setBooking
  • Custom Header = [leave empty]

Body Data:

{
"authentication":
{
"apiKey": "my_very_secret_api_key",
"propKey": "secret_key_for_prop_XXXXXX"
},
"bookId": "[BOOKID]",
"message": "[MESSAGE] - Append this message"
}

10.9.2 Use API/Webhook to write the value of the 'commission' field to a new invoice item

You can create a new invoice item that contains the price of the channel's commission as a negative value to subtract it from the room price. You use the API JSON function setBooking for this. First you need to configure access to the API:

You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.
API key:

  • (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS "API Key 1"
  • API Key = my_very_secret_api_key
  • API Key Access = allow any IP
  • IP Whitelist = [leave empty]
  • Allow Writes = Yes
  • Property Access = Owned by this account only
  • Property key:
  • (SETTINGS) PROPERTIES > ACCESS> propKey = secret_key_for_prop_XXXXXX

Set the triggers you need, for example:

Booking Source = Booking.com

Set the webhook like this:

  • URL = https://api.beds24.com/json/setBooking
  • Custom Header = [leave empty]
  • Body Data =
{
"authentication":
{
"apiKey": "my_very_secret_api_key",
"propKey": "secret_key_for_prop_XXXXXX"
},
"bookId": "[BOOKID]",
"invoice":
[
{
"description": "Booking.com Commission",
"status": "",
"qty": "1",
"price": "-[COMMISSIONNUM]",
"vatRate": "7.00",
"type": "0",
"invoiceeId": ""
}
]
}

10.9.3 Use Auto Action/Webhook to write to send data to Integromat

You can use this option to send data to your Integromat account.

Set the rules in the Trigger tab, when you need to send the data to Integromat.

Go to Webhook tab:

URL = https://hook.integromat.com/ followed by your integromat account key.

Body Data = you can use the template variables allows in the list for Integromat [Data fields]

For example :-

bookingData={

"bookId":"[BOOKID]",

"guestMobileNum":"[GUESTMOBILENUM]",

"guestMobile":"[GUESTMOBILE]",

"guestSMS":"[GUESTSMS:44]",

"guestFirstName":"[REPLACE|&|and|[GUESTFIRSTNAME]]",

"propertyName":"[PROPERTYNAME]",

"propertyId":"[PROPERTYID]",

"firstNight":"[FIRSTNIGHTSHORT]",

"lastNight":"[LEAVINGDAYSHORT]"

}

10.9.4 Use webhook to switch a Shelly on

Here is a simple PHP script with which you can switch a Shelly via an autoaction in beds24.

You can use this to switch on a string of lights on the day of arrival or to charge the night storage heating if a certain info code is set in the booking on the day before arrival.

Create an auto action and enter the PHP script ‘beds24-shelly-steuern.php’ under ‘Webhook’. The parameters for the control are transferred under ‘Data in body’:

id:b0b21c1xxxxx shelly_server:shelly-123-eu.shelly.cloud auth_key:ABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZ shelly_url:device/relay/control parameter:channel=0&turn=on email_result:[email protected] remarks:Text, z.B. mit Template Variablen [GUESTFULLNAME] und [BOOKID]

10.10 Testing for Modified bookings

10.10.1 Use Template Variables to test for Modified bookings

You can test if the booking has been modified, adding a booking info code to the booking will then allow you to trigger other auto actions, run reports etc.

Trigger tab

  • Trigger Event = Booking (but not after Check-in) OR Booking
  • Trigger Time = 1 day (this will ensure that NEW bookings do not trigger this auto action)
  • Time Window = 365 days
  • Booking Status = All not cancelled
  • Template Variables [IF>^[MODIFYDATE:{%Y-%m-%d %H:%M:%S}]^[CURRENTDATE:-1day{%Y-%m-%d %H:%M:%S}]^yes~no] equal yes

Booking tab: (Optional)

  • Flag text = (enter the text you require)
  • Flag Colour = Set as required

Booking Info tab : (optional)

  • Booking Info Code = MODIFIED
  • Booking Info Text = Booking modification