Difference between revisions of "Auto Actions"
m (1版 をインポートしました) |
Beds24>Lesley (→Credit card is collected at time of booking and you want to 'Capture' a Security Deposit.) |
||
Line 4: | Line 4: | ||
[[Category:Troubleshooting]] | [[Category:Troubleshooting]] | ||
[[Category:Automation]] | [[Category:Automation]] | ||
− | + | [[Category:Webhooks]] | |
+ | <div class="heading">Auto Actions</div> | ||
− | + | This page is about the menu {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS and explains how to set up and use Auto Actions. | |
− | + | __TOC__ | |
− | + | == General Information and Setup == | |
− | + | 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. Actions can be to send pre-drafted emails or SMS, change booking or invoice information or run webhooks. | |
− | + | 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. | |
− | + | '''You can choose to send an auto action automatically or manually:''' | |
− | + | '''Auto sending:''' | |
− | + | 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 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. | ||
− | + | '''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 SETTINGS -> ACCOUNT -> OUTGOING EMAIL. | ||
+ | |||
+ | <span style="color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> Email sending works per account. | ||
+ | |||
+ | <span style="color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> 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. | ||
+ | |||
+ | <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: 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. | ||
== Trigger == | == Trigger == | ||
Line 38: | Line 50: | ||
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. | ||
− | == Email == | + | == Actions == |
+ | |||
+ | === 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 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. | ||
*To send Emails automatically you need to set up your outgoing Email address in SETTINGS -> ACCOUNT -> OUTGOING EMAIL. | *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 tab. Manual Emails will open in | + | *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. |
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. | ||
Line 53: | Line 67: | ||
If this does not work it will pop and send through your desktop. In this case you will see it in your Sent box. | If this does not work it will pop and send through your desktop. In this case you will see it in your Sent box. | ||
− | === Email Attachments=== | + | ==== Email Attachments ==== |
You can choose to attach an invoice or a booking template as a PDF file to emails sent by Auto Actions. | 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. | 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 | + | Other files can not be attached. We recommend you use a link to a file you upload to your web site. |
− | == 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. | |
− | == Booking == | + | === Booking === |
− | Go to 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. |
− | + | === Booking Info === | |
+ | Set up auto actions which automatically add or remove info codes. | ||
+ | |||
+ | === Invoice === | ||
+ | Automatically add invoice items or pending payments. | ||
Invoice changes are applied before the mail is sent. | Invoice changes are applied before the mail is sent. | ||
− | == | + | === API === |
+ | Create auto actions which trigger HTTP POST notifications. | ||
+ | |||
+ | === Webhook === | ||
+ | Create auto actions which trigger a web hook when the trigger conditions are met. | ||
+ | |||
+ | == Test == | ||
+ | Test why an auto action did not trigger. | ||
+ | |||
+ | == 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 booking set to allow Allow Auto Actions ("Mails" tab of the booking)? | ||
+ | *Do all trigger events apply to the booking? | ||
+ | |||
+ | '''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. | ||
− | |||
+ | == Examples == | ||
+ | <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 tab | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 84: | Line 133: | ||
*Execution = One time only | *Execution = One time only | ||
*Booking Status = Cancelled | *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 tab: | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 98: | Line 152: | ||
Booking changes are applied before the mail is sent. | Booking changes are applied before the mail is sent. | ||
+ | </div> | ||
+ | </div> | ||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
− | === | + | ===Set a flag/colour for a booking coming from a certain channel=== |
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
Line 112: | Line 172: | ||
*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 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"> | ||
Trigger tab: | Trigger tab: | ||
Line 122: | Line 187: | ||
*Trigger Window = 365 | *Trigger Window = 365 | ||
*Booking Source = All (for example) | *Booking Source = All (for example) | ||
+ | *Booking Status = Cancelled | ||
− | + | Message tab: | |
*Trigger Action = Auto | *Trigger Action = Auto | ||
− | *Send Email = Guest | + | *Send Email = Guest |
− | + | <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. | |
+ | </div> | ||
+ | </div> | ||
− | === | + | <div class="mw-collapsible mw-collapsed"> |
+ | <div class="headline-collapse" > | ||
+ | ===Change the status of all upcoming direct bookings to "Cancelled" and send an Email to the guest === | ||
+ | </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: | ||
+ | *Booking Status = Cancelled | ||
+ | |||
+ | Message tab: | ||
+ | *Trigger Action = Auto | ||
+ | *Send Email = Guest | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <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 tab: | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 145: | Line 238: | ||
The fee will be added the next time the auto actions run. | 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 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, add a booking info tab for information and reporting | ||
+ | |||
+ | 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 | ||
+ | |||
+ | 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 = 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 | ||
+ | |||
+ | </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"> | ||
+ | |||
+ | Trigger tab: | ||
+ | *Trigger Event = After Booking | ||
+ | *Trigger Time = immediate | ||
+ | *Booking Source =All (for example, you can also set different rules for different channels) | ||
+ | |||
+ | Invoice tab: | ||
+ | *Payment Type = Percent of balance due | ||
+ | *Description = the text you will see in the "Charges and Payments" tab (Payment Balance) | ||
+ | *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 = Auto | ||
+ | *Payment Due = check in -3 | ||
+ | |||
+ | |||
+ | <span style="color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> Automatic collection is only available for customer who use [[Stripe]]. | ||
+ | </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 = After Booking | ||
+ | *Trigger Time = immediate | ||
+ | *Booking Source =All (for example, you can also set different rules for different channels) | ||
+ | |||
+ | 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 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 a flag when a payment was made=== | ===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 = After 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=== | ||
+ | </div> | ||
+ | <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: | |
+ | *Execution = One time only | ||
+ | *Flag Text = Stripe Payment Failed | ||
+ | *Flag Colour - choose the flag colour | ||
+ | </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 tab: | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 157: | Line 417: | ||
*Booking Source = All | *Booking Source = All | ||
*Booking Status = All but not cancelled | *Booking Status = All but not cancelled | ||
− | * | + | *Booking Info Code = BOOKINGCOMCARD |
Booking tab: | Booking tab: | ||
*Execution = One time only | *Execution = One time only | ||
− | *Flag Text = | + | *Flag Text = Failed CC reported to Booking.com |
*Flag Colour - choose the flag colour | *Flag Colour - choose the flag colour | ||
+ | </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 = After Booking | ||
+ | *Trigger Time = Immediate | ||
+ | *Trigger Window = 365 | ||
+ | *Booking Source = All | ||
+ | *Booking Status = All but not cancelled | ||
+ | *Invoice Balance = Any Payment made | ||
+ | |||
+ | Booking Info tab: | ||
+ | *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 class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
===Apply a flag when a booking is cancelled=== | ===Apply a flag when a booking is cancelled=== | ||
− | + | </div> | |
+ | <div class="mw-collapsible-content"> | ||
Trigger tab | Trigger tab | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 178: | Line 461: | ||
*Flag text = (enter the text you require) | *Flag text = (enter the text you require) | ||
*Flag Colour = Set as required | *Flag Colour = Set as required | ||
+ | </div> | ||
+ | </div> | ||
− | ===Send an | + | <div class="mw-collapsible mw-collapsed"> |
− | + | <div class="headline-collapse" > | |
+ | ===Send an message or SMS to Guest when booking made more than 10 days in advance=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
*Trigger Event = Check-in | *Trigger Event = Check-in | ||
Line 191: | Line 479: | ||
*Booking Status = No Change | *Booking Status = No Change | ||
− | + | Message tab or SMS tab: | |
*Update details as appropriate | *Update details as appropriate | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Send an message or SMS to Guest when booking made more than 7 days in advance=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
+ | Alternatively you an use Between Booking and Check in | ||
+ | |||
+ | Trigger tab: | ||
+ | *Trigger Event = Booking (but not after check-in) | ||
+ | *Trigger Time = Immediate | ||
+ | *Trigger Window = 1 day | ||
+ | Between Booking and Check in = 7 to 999 | ||
+ | *Booking Status = All not cancelled | ||
+ | |||
+ | Booking tab: | ||
+ | *Execution = One time only | ||
+ | *Booking Status = No Change | ||
+ | Message tab or SMS tab: | ||
+ | *Update details as appropriate | ||
+ | </div> | ||
+ | </div> | ||
− | ===Send an | + | <div class="mw-collapsible mw-collapsed"> |
+ | <div class="headline-collapse" > | ||
+ | ===Send an message or SMS to Guest when booking made more last minute booking - 6 days or less=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
+ | Trigger tab: | ||
+ | *Trigger Event = Booking (but not after check-in) | ||
+ | *Trigger Time = Immediate | ||
+ | *Trigger Window = 1 day | ||
+ | Between Booking and Check in = 0 to 6 | ||
+ | *Booking Status = All not cancelled | ||
+ | |||
+ | Booking tab: | ||
+ | *Execution = One time only | ||
+ | *Booking Status = No Change | ||
+ | |||
+ | Message tab or SMS tab: | ||
+ | *Update details as appropriate | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Send an Email with a key code for a specific unit one day before check-in=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
*Trigger Event = Check-in | *Trigger Event = Check-in | ||
Line 208: | Line 545: | ||
*Booking Status = No Change | *Booking Status = No Change | ||
− | + | Message tab: | |
*Enter your text. If you are using the "Additional Information" function SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables | *Enter your text. If you are using the "Additional Information" function SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables | ||
Line 214: | Line 551: | ||
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. | 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. | ||
+ | </div> | ||
+ | </div> | ||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Send an Email to the guest when a payment is made=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
+ | 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: | |
+ | *Enter your text. | ||
+ | You can use Invoice Template variables showing the booking charges/payments. | ||
+ | </div> | ||
+ | </div> | ||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Send an Email to guests from Channels=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 228: | Line 587: | ||
*Booking Status = No Change | *Booking Status = No Change | ||
− | + | Message tab: | |
− | *Send Email = Guest | + | *Send Email = Guest |
*Enter you text. If you are using the "Additional Information" function SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables | *Enter you text. If you are using the "Additional Information" function SETTINGS->PROPERTIES->ROOMS->SET UP "Unit Names" you can use template variables | ||
Line 235: | Line 594: | ||
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. | 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. | ||
+ | </div> | ||
+ | </div> | ||
− | + | <div class="mw-collapsible mw-collapsed"> | |
− | === | + | <div class="headline-collapse" > |
− | + | ===Set a flag for a bookings from a channel which have breakfast included=== | |
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 250: | Line 613: | ||
*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 | + | 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" > | ||
+ | ===Send a message (Email or sms) to guests that have Checked-out 30 days or more=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
*Trigger Event = After Check-out | *Trigger Event = After Check-out | ||
Line 260: | Line 627: | ||
*Trigger Window = 365 days | *Trigger Window = 365 days | ||
− | + | Message or SMS tab: | |
Enter the details you want to send. | Enter the details you want to send. | ||
Line 267: | Line 634: | ||
*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 | ||
+ | </div> | ||
+ | </div> | ||
− | + | <div class="mw-collapsible mw-collapsed"> | |
− | === | + | <div class="headline-collapse" > |
− | + | ===Send a Request for payment to your guests for all bookings=== | |
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
Line 278: | Line 649: | ||
Booking Source = ALL (or select the booking source/Channel) | Booking Source = ALL (or select the booking source/Channel) | ||
− | + | Message tab: | |
− | Send | + | Send Email : select the appropriate option |
*Edit Email Subject - enter the subject for your Guests | *Edit Email Subject - enter the subject for your Guests | ||
− | *Edit Email Text :- enter the | + | *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. | [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. | ||
Line 291: | Line 662: | ||
*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 | + | 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" > | ||
+ | ===Send a Request for payment to your guests XX days before arrival=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
− | *Trigger Event = Check-in | + | *Trigger Event = Check-in |
*Trigger Time = -42 | *Trigger Time = -42 | ||
*Trigger Window = 1 day | *Trigger Window = 1 day | ||
Booking Source = ALL (or select the booking source/Channel) | Booking Source = ALL (or select the booking source/Channel) | ||
− | Email tab: | + | Message tab: |
+ | |||
+ | Send Email : select the appropriate option | ||
+ | |||
+ | *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. | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Send a Request for payment to your guests XX days after booking=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
+ | |||
+ | 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. | ||
− | Send | + | '''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 Email : select the appropriate option | ||
*Edit Email Subject - enter the subject for your Guests | *Edit Email Subject - enter the subject for your Guests | ||
− | *Edit Email Text :- enter the | + | *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. | [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. | ||
Line 315: | Line 730: | ||
*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 | + | 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 may you need) ''' | ||
+ | *Trigger Time = +14 days (days you want to collect the payments) | ||
+ | *Trigger Window = 1 day | ||
+ | |||
+ | '''Setup booking info code''' | ||
+ | |||
+ | Go to SETTINGS -> ACCOUNT -> PREFERENCES -> BOOKINGS -> Booking Info Code Values and enter MULTIPLE (or the value you want to use to trigger) | ||
+ | '''Update Booking to allow Multiple payments''' | ||
− | + | *Open the booking | |
+ | **Go to Booking Info Tab and from the drop down list | ||
+ | **Select the value 'MULTIPLE' (or the value you want to use to trigger) | ||
+ | </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 tab: | ||
Line 329: | Line 764: | ||
*Invoice Balance = Any Payment made | *Invoice Balance = Any Payment made | ||
− | + | Message tab: | |
− | *Send | + | *Send Email : select appropriate option |
− | *Enter : Subject and | + | *Enter : Subject and Email content |
Booking tab: (optional) | Booking tab: (optional) | ||
Line 346: | Line 781: | ||
Setting details with the Booking tab and Booking info tab allows you to trigger additional (follow on) Auto Actions and Reports. | 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=== | ===Apply a flag when booking is fully paid=== | ||
− | + | </div> | |
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
*Trigger Event = After Booking | *Trigger Event = After Booking | ||
Line 355: | Line 794: | ||
*Trigger Window = 365 | *Trigger Window = 365 | ||
*Booking Source = All | *Booking Source = All | ||
− | *Booking Status = All | + | *Booking Status = All not cancelled |
*Invoice Balance = ZERO | *Invoice Balance = ZERO | ||
Line 362: | Line 801: | ||
*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 | ||
+ | </div> | ||
+ | </div> | ||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Send Email in a 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 Field Contains - select "Language" in the next field enter: the short code for the language this Auto Action is for. | ||
+ | |||
+ | Email tab: | ||
+ | *Enter the message in the appropriate language under your default language. | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
===Send SMS in a certain language (if it is the language of the booking) or a default language=== | ===Send SMS in a certain language (if it is the language of the booking) or a default language=== | ||
− | + | </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. | 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. | ||
Line 375: | Line 833: | ||
*Phone Number = [GUESTMOBILE] | *Phone Number = [GUESTMOBILE] | ||
*SMS Message = [IF=:[GUESTLANGUAGE]:fr:French_text|English_text] | *SMS Message = [IF=:[GUESTLANGUAGE]:fr:French_text|English_text] | ||
+ | </div> | ||
+ | </div> | ||
− | === | + | <div class="mw-collapsible mw-collapsed"> |
+ | <div class="headline-collapse" > | ||
+ | ===Assign invoice numbers=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
Trigger tab: | Trigger tab: | ||
*Trigger Event = Check-out | *Trigger Event = Check-out | ||
Line 384: | Line 848: | ||
Invoice tab: | Invoice tab: | ||
*Assign Invoice Number = yes | *Assign Invoice Number = yes | ||
+ | </div> | ||
+ | </div> | ||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
===Group check-in === | ===Group check-in === | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
This requires the master booking to be checked-in via the check-in function. | This requires the master booking to be checked-in via the check-in function. | ||
Line 400: | Line 870: | ||
Booking info tab : | Booking info tab : | ||
*Info Code = CHECKIN | *Info Code = CHECKIN | ||
+ | </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 Time = -2 (the number of days before check-in you want to sent the code or link) | ||
+ | *Trigger Window = 2 | ||
+ | *Booking Source = All | ||
+ | *Booking Status = All but not cancelled | ||
+ | *Group bookings = Trigger all on master | ||
+ | *Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL | ||
+ | |||
+ | Message tab: | ||
+ | *Send Email = Guest and cc | ||
+ | *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 class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
− | == | + | ===Send Email to all current guest === |
− | + | </div> | |
− | + | <div class="mw-collapsible-content"> | |
− | * | + | Trigger tab: |
− | * | + | *Trigger Event = Check-in |
− | + | *Trigger Time = Immediate | |
− | + | *Trigger Window = 14(the max number of days your guests can stay) | |
− | * | + | *Booking Source = All |
+ | *Booking Status = All but not cancelled | ||
+ | *Group bookings = Trigger all on master | ||
+ | *Any Booking Info Code = CHECKIN | ||
+ | *Exclude Booking Info Code = CHECKOUT | ||
+ | |||
+ | Message tab: | ||
+ | *Send Email = Guest | ||
+ | *EMail Subject = Enter the appropriate details | ||
+ | *Email Text = Your text which includes the details for your current guests. | ||
+ | |||
+ | 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 class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Send Email with a PDF attachment=== | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
+ | |||
+ | You can send Invoice or Booking Template attachments to your Guests. | ||
+ | |||
+ | Setup your Invoice or Booking Template, go to SETTINGS -> GUEST MANAGEMENT -> INVOICING or SETTINGS -> GUEST MANAGEMENT -> BOOKING TEMPLATES | ||
+ | |||
+ | Trigger tab: | ||
+ | *Trigger Event = Checkout | ||
+ | *Trigger Time = Immediate | ||
+ | *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: | ||
+ | *Send Email = Guest API/Smart Email (or one of the other options) | ||
+ | *Attachment = Select an option from the drop down list. | ||
+ | *EMail Subject = Enter the appropriate details | ||
+ | *Email Text = Your text which includes the details for your current 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. | ||
+ | |||
+ | 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 class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Add CHECKIN Booking info code to bookings === | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
+ | |||
+ | 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 | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <div class="mw-collapsible mw-collapsed"> | ||
+ | <div class="headline-collapse" > | ||
+ | ===Add CHECKOUT Booking info code to bookings === | ||
+ | </div> | ||
+ | <div class="mw-collapsible-content"> | ||
+ | |||
+ | 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 | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <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:''' | ||
+ | *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 = <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:''' | ||
+ | *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 = <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> |
Revision as of 12:13, 30 September 2020
This page is about the menu {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS and explains how to set up and use Auto Actions.
Contents
- 1 General Information and Setup
- 2 Trigger
- 3 Actions
- 4 Test
- 5 Troubleshooting
- 6 Examples
- 6.1 Change the status of all "Request" bookings to "Cancelled" after three days
- 6.2 Change the status of all bookings which have been imported from Ical to "Request"
- 6.3 Set a flag/colour for a booking coming from a certain channel
- 6.4 Send an Email to the guest when the status of a booking changes to "Cancelled"
- 6.5 Change the status of all upcoming direct bookings to "Cancelled" and send an Email to the guest
- 6.6 Add a fee to all bookings from a channel
- 6.7 Add a pending payment
- 6.8 Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)
- 6.9 'Capture' a Security Deposit when Credit card is collected at time of booking.
- 6.10 Apply a flag when a payment was made
- 6.11 Apply a flag when a payment FAILS at Stripe
- 6.12 Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe
- 6.13 Apply an info code and and/or icon when a payment was made
- 6.14 Apply a flag when a booking is cancelled
- 6.15 Send an message or SMS to Guest when booking made more than 10 days in advance
- 6.16 Send an message or SMS to Guest when booking made more than 7 days in advance
- 6.17 Send an message or SMS to Guest when booking made more last minute booking - 6 days or less
- 6.18 Send an Email with a key code for a specific unit one day before check-in
- 6.19 Send an Email to the guest when a payment is made
- 6.20 Send an Email to guests from Channels
- 6.21 Set a flag for a bookings from a channel which have breakfast included
- 6.22 Send a message (Email or sms) to guests that have Checked-out 30 days or more
- 6.23 Send a Request for payment to your guests for all bookings
- 6.24 Send a Request for payment to your guests XX days before arrival
- 6.25 Send a Request for payment to your guests XX days after booking
- 6.26 Apply a flag when deposit was made prior to Check-in
- 6.27 Apply a flag when booking is fully paid
- 6.28 Send Email in a the guests language to an internal Email address
- 6.29 Send SMS in a certain language (if it is the language of the booking) or a default language
- 6.30 Assign invoice numbers
- 6.31 Group check-in
- 6.32 Send Remotelock/Lockstate, Nuki PIN or Chekin Link
- 6.33 Send Email to all current guest
- 6.34 Send Email with a PDF attachment
- 6.35 Add CHECKIN Booking info code to bookings
- 6.36 Add CHECKOUT Booking info code to bookings
- 6.37 Use API/Webhook to write to the field 'Message'
- 6.38 Use API/Webhook to write the value of the 'commission' field to a new invoice item
General Information and Setup
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. Actions can be to send pre-drafted emails or SMS, change booking or invoice information or run webhooks.
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.
You can choose to send an auto action automatically or manually:
Auto sending:
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 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.
Before setting up an auto action please note:
{{#fas:exclamation-triangle}} To use this function you need to set the system to use your own Email address for outgoing emails under SETTINGS -> ACCOUNT -> OUTGOING EMAIL.
{{#fas:exclamation-triangle}} Email sending works per account.
{{#fas:exclamation-triangle}} 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.
{{#fas:lightbulb}} Confirmation messages will send automatically to the guest. You can customize them in SETTINGS -> GUEST MANAGEMENT -> CONFIRMATION MESSAGES.
{{#fas:lightbulb}} 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.
Trigger
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.
"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.
Both "Trigger Time" and "Time Window" are relative to a "Trigger Event" i.e. check-in, check-out, time of booking.
Actions
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.
- 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 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 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 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.
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.
SMS
You can automatically send SMS messages. Please note that a fee per SMS message applies if this function is activated.
{{#fas:exclamation-triangle}} 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.
Booking
Go to the tab 'Booking' to set up an auto action which modifies something in the booking.
Booking Info
Set up auto actions which automatically add or remove info codes.
Invoice
Automatically add invoice items or pending payments.
Invoice changes are applied before the mail is sent.
API
Create auto actions which trigger HTTP POST notifications.
Webhook
Create auto actions which trigger a web hook when the trigger conditions are met.
Test
Test why an auto action did not trigger.
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 booking set to allow Allow Auto Actions ("Mails" tab of the booking)? *Do all trigger events apply to the booking?
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.
Examples
Change the status of all "Request" bookings to "Cancelled" after three days
Trigger tab
- Trigger Event = After Booking
- Trigger Time = 3 days
- Booking Status = Request
Booking tab:
- Execution = One time only
- Booking Status = Cancelled
Change the status of all bookings which have been imported from Ical to "Request"
Trigger tab:
- Trigger Event = After 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.
Set a flag/colour for a booking coming from a certain channel
Trigger tab:
- Trigger Event = After 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.
Send an Email to the guest when the status of a booking changes to "Cancelled"
Trigger tab:
- Trigger Event = Check-in
- Trigger Time = -365
- Trigger Window = 365
- Booking Source = All (for example)
- Booking Status = Cancelled
Message tab:
- Trigger Action = Auto
- Send Email = Guest
{{#fas:exclamation-triangle}} If you are using deposit collection make sure you set SETTINGS->PAYMENTS->PAYMENT COLLECTION "Non Payment Booking Status" = Request.
Change the status of all upcoming direct bookings to "Cancelled" and send an Email to the guest
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:
- Booking Status = Cancelled
Message tab:
- Trigger Action = Auto
- Send Email = Guest
Add a fee to all bookings from a channel
Trigger tab:
- Trigger Event = After Booking
- Trigger Time = Immediate
- Booking Source = Expedia (for example)
Invoice tab:
- Type = Amount
- 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.
Add a pending payment
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, add a booking info tab for information and reporting
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
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 = 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
Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)
Trigger tab:
- Trigger Event = After Booking
- Trigger Time = immediate
- Booking Source =All (for example, you can also set different rules for different channels)
Invoice tab:
- Payment Type = Percent of balance due
- Description = the text you will see in the "Charges and Payments" tab (Payment Balance)
- 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 = Auto
- Payment Due = check in -3
{{#fas:exclamation-triangle}} Automatic collection is only available for customer who use Stripe.
'Capture' a Security Deposit when Credit card is collected at time of booking.
Trigger tab:
- Trigger Event = After Booking
- Trigger Time = immediate
- Booking Source =All (for example, you can also set different rules for different channels)
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
{{#fas:exclamation-triangle}} 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
Apply a flag when a payment was made
{{#fas:lightbulb}} 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 = After 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
Apply a flag when a payment FAILS at Stripe
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:
- Execution = One time only
- Flag Text = Stripe Payment Failed
- Flag Colour - choose the flag colour
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 = After Booking
- Trigger Time = Immediate
- Trigger Window = 365
- Booking Source = All
- Booking Status = All but 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
Apply an info code and and/or icon when a payment was made
Trigger tab:
- Trigger Event = After Booking
- Trigger Time = Immediate
- Trigger Window = 365
- Booking Source = All
- Booking Status = All but not cancelled
- Invoice Balance = Any Payment made
Booking Info tab:
- Execution = One time only
- Info Code = Enter the preset code for the icon or info code which you have created in SETTINGS->ACCOUNT->PREFERENCES.
Apply a flag when a booking is cancelled
Trigger tab
- Trigger Event = After 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 = Set as required
Send an message or SMS to Guest when booking made more than 10 days in advance
Trigger tab:
- Trigger Event = Check-in
- Trigger Time = -365 days
- Trigger Window = 355 days
- Booking Status = All not cancelled
Booking tab:
- Execution = One time only
- Booking Status = No Change
Message tab or SMS tab:
- Update details as appropriate
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:
- Trigger Event = Booking (but not after check-in)
- Trigger Time = Immediate
- Trigger Window = 1 day
Between Booking and Check in = 7 to 999
- Booking Status = All not cancelled
Booking tab:
- Execution = One time only
- Booking Status = No Change
Message tab or SMS tab:
- Update details as appropriate
Send an message or SMS to Guest when booking made more last minute booking - 6 days or less
Trigger tab:
- Trigger Event = Booking (but not after check-in)
- Trigger Time = Immediate
- Trigger Window = 1 day
Between Booking and Check in = 0 to 6
- Booking Status = All not cancelled
Booking tab:
- Execution = One time only
- Booking Status = No Change
Message tab or SMS tab:
- Update details as appropriate
Send an Email with a key code for a specific unit one day before check-in
Trigger tab:
- Trigger Event = Check-in
- Trigger Time = -1 day
- Trigger Window = 1 day
- 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:
- Enter your text. 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.
Send an Email to the guest when a payment is made
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:
- Enter your text.
You can use Invoice Template variables showing the booking charges/payments.
Send an Email to guests from Channels
Trigger tab:
- Trigger Event = After Booking
- Trigger Time = Immediate
- Trigger Window = 1 day
- Booking Source = Channel Manager
Booking tab:
- Execution = One time only
- Booking Status = No Change
Message tab:
- Send Email = Guest
- Enter you text. 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.
Set a flag for a bookings from a channel which have breakfast included
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:
- 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.
Send a message (Email or sms) to guests that have Checked-out 30 days or more
Trigger tab:
- Trigger Event = After Check-out
- Trigger Time = 30 days
- Trigger Window = 365 days
Message or SMS tab: Enter the details you want to send.
Booking tab: (optional)
- Execution = One time only
- Flag Text = The text you want to display
- Flag Colour - choose the flag colour
Send a Request for payment to your guests for all bookings
Trigger tab:
- Trigger Event = After Booking
- Trigger Time = Immediate
- Trigger Window = 1 day
Booking Source = ALL (or select the booking source/Channel)
Message tab:
Send Email : select the appropriate option
- 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.
Send a Request for payment to your guests XX days before arrival
Trigger tab:
- Trigger Event = Check-in
- Trigger Time = -42
- Trigger Window = 1 day
Booking Source = ALL (or select the booking source/Channel)
Message tab:
Send Email : select the appropriate option
- 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.
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 Email : select the appropriate option
- 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 may you need)
- Trigger Time = +14 days (days you want to collect the payments)
- Trigger Window = 1 day
Setup booking info code
Go to SETTINGS -> ACCOUNT -> PREFERENCES -> BOOKINGS -> Booking Info Code Values and enter MULTIPLE (or the value you want to use to trigger)
Update Booking to allow Multiple payments
- Open the booking
- Go to Booking Info Tab and from the drop down list
- Select the value 'MULTIPLE' (or the value you want to use to trigger)
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.
Apply a flag when booking is fully paid
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:
- Execution = One time only
- Flag Text = The text you want to display
- Flag Colour - choose the flag colour
Send Email in a 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:
- Booking Field Contains - select "Language" in the next field enter: the short code for the language this Auto Action is for.
Email tab:
- Enter the message in the appropriate language under your default language.
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 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
Booking tab: Whatever you want
SMS tab:
- Phone Number = [GUESTMOBILE]
- SMS Message = [IF=:[GUESTLANGUAGE]:fr:French_text|English_text]
Assign invoice numbers
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:
- Assign Invoice Number = yes
Group check-in
This requires the master booking to be checked-in via the check-in function.
Trigger tab:
- Trigger Event = After Booking
- Trigger Time = immediately
- Trigger Window = 365
- Booking Source = All
- Booking Status = All but not cancelled
- Group bookings" = Trigger all on master
- Info Code = CHECKIN
Booking info tab :
- Info Code = CHECKIN
Send Remotelock/Lockstate, Nuki PIN or Chekin Link
Trigger tab:
- 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 = All
- Booking Status = All but not cancelled
- Group bookings = Trigger all on master
- Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL
Message tab:
- Send Email = Guest and cc
- EMail Subject = Your access code (your text)
- Email Text = Your text which includes the template variable [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN]
Send Email to all current guest
Trigger tab:
- Trigger Event = Check-in
- Trigger Time = Immediate
- Trigger Window = 14(the max number of days your guests can stay)
- Booking Source = All
- Booking Status = All but not cancelled
- Group bookings = Trigger all on master
- Any Booking Info Code = CHECKIN
- Exclude Booking Info Code = CHECKOUT
Message tab:
- Send Email = Guest
- EMail Subject = Enter the appropriate details
- Email Text = Your text which includes the details for your current guests.
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.
Send Email with a PDF attachment
You can send Invoice or Booking Template attachments to your Guests.
Setup your Invoice or Booking Template, go to SETTINGS -> GUEST MANAGEMENT -> INVOICING or SETTINGS -> GUEST MANAGEMENT -> BOOKING TEMPLATES
Trigger tab:
- Trigger Event = Checkout
- Trigger Time = Immediate
- 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:
- Send Email = Guest API/Smart Email (or one of the other options)
- Attachment = Select an option from the drop down list.
- EMail Subject = Enter the appropriate details
- Email Text = Your text which includes the details for your current 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.
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.
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
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
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"
- }
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": ""
- }
- {
- ]
- }