Difference between revisions of "Auto Actions"
Line 619: | Line 619: | ||
You need two keys to use our API - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br> | You need two keys to use our API - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br> | ||
'''API key:'''<br> | '''API key:'''<br> | ||
− | Go to | + | *Go to |
Settings > Account > Account Access > API Key 1: | Settings > Account > Account Access > API Key 1: | ||
API Key = my_very_secret_api_key | API Key = my_very_secret_api_key |
Revision as of 21:44, 2 March 2020
This page is about the menu SETTINGS -> GUEST MANAGEMENT -> AUTO ACTIONS
An Auto Action is an action which can be programmed to occur at a time relative to the time the booking was made, to the check in date or to the check out date. To use this function you need to set the system to use you own Email address for sending in SETTINGS->ACCOUNT->OUTGOING EMAIL.
The action can be a pre-canned email sent to the guest or to a fixed email address, and it can also make changes to the booking information. Click on "Edit" to modify an existing auto action or on "Create New Action" to set up a new auto action:
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.
Note: Confirmation messages will send automatically to the guest. You can customize them in SETTINGS ->GUEST MANAGEMENT->CONFIRMATION MESSAGES.
Email sending works per account.
Note: 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.
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 manual by clicking on the 'Send' button you will need to make sure you are logged into the account which uses the EMail address you want to send from.
Contents
- 1 Trigger
- 2 Email
- 3 SMS
- 4 Booking
- 5 Booking Info
- 6 Invoice
- 7 API
- 8 Webhook
- 9 Test
- 10 Examples
- 10.1 Automatically change the status of all "Request" bookings to "Cancelled" after three days
- 10.2 Automatically change the status of all bookings which have been imported from Ical to "Request"
- 10.3 Automatically set a flag/colour for a booking coming from a certain channel
- 10.4 Automatically send an Email to the guest when the status of a booking changes to "Cancelled"
- 10.5 Automatically add a fee to all bookings from a channel
- 10.6 Add a pending payment
- 10.7 Apply a flag when a payment was made
- 10.8 Apply a flag when a payment FAILS at Stripe
- 10.9 Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe
- 10.10 Apply an info code and and/or icon when a payment was made
- 10.11 Apply a flag when a booking is cancelled
- 10.12 Send an message or SMS to Guest when booking made more than 10 days in advance
- 10.13 Send an message or SMS to Guest when booking made more than 7 days in advance
- 10.14 Send an message or SMS to Guest when booking made more last minute booking - 6 days or less
- 10.15 Send an Email with a key code for a specific unit one day before check-in
- 10.16 Send an Email to guests from Channels
- 10.17 Automatically set a flag for a bookings from a channel which have breakfast included
- 10.18 Automatically send a message (Email or sms) to guests that have Checked-out 30 days or more
- 10.19 Automatically send a Request for payment to your guests for all bookings
- 10.20 Automatically send a Request for payment to your guests XX days before arrival
- 10.21 Apply a flag when deposit was made prior to Check-in
- 10.22 Apply a flag when booking is fully paid
- 10.23 Send SMS in a certain language (if it is the language of the booking) or a default language
- 10.24 Automatically assign invoice numbers
- 10.25 Group check-in
- 10.26 Send Remotelock/Lockstate PIN
- 10.27 Send Email to all current guest
- 10.28 Add CHECKIN Booking info code to bookings
- 10.29 Add CHECKOUT Booking info code to bookings
- 10.30 Use API/Webhook to write to the field 'Message'
- 11 Troubleshooting
1 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.
2 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.
2.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.
3 SMS
You can automatically send SMS messages. Please note that a fee per SMS message applies if this function is activated.
NOTE: 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.
4 Booking
Go to the tab 'Booking' to set up an auto action which modifies something in the booking.
5 Booking Info
Set up auto actions which automatically add or remove info codes.
6 Invoice
Automatically add invoice items or pending payments.
Invoice changes are applied before the mail is sent.
7 API
Create auto actions which trigger HTTP POST notifications.
8 Webhook
Create auto actions which trigger a web hook when the trigger conditions are met.
9 Test
Test why an auto action did not trigger.
10 Examples
10.1 Automatically 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
10.2 Automatically 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.
10.3 Automatically 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.
10.4 Automatically 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
Note: If you are using deposit collection make sure you set SETTINGS->PAYMENTS->PAYMENT COLLECTION "Non Payment Booking Status" = Request.
10.5 Automatically 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.
10.6 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
- 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
10.6.1 Example: Credit card is collected at time of booking and full payment is due 3 days prior to arrival.
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
Note: Automatic collection is only available for customer who use Stripe.
10.6.2 Example: Credit card is collected at time of booking and you want to 'Capture' a Security Deposit.
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
Note: 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.7 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 = 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
10.8 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
10.9 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
10.10 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.
10.11 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
10.12 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
10.13 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
10.14 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
10.15 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.
10.16 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.
10.17 Automatically 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.
10.18 Automatically 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
10.19 Automatically 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.
10.20 Automatically 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.
10.21 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.22 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
10.23 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]
10.24 Automatically 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
10.25 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
10.26 Send Remotelock/Lockstate PIN
Trigger tab:
- Trigger Event = Check-in
- Trigger Time = -2 (the number of days before check-in you want to sent the code)
- Trigger Window = 2
- Booking Source = All
- Booking Status = All but not cancelled
- Group bookings = Trigger all on master
- Info Code = LOCKSTATE_PIN
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]
10.27 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.
10.28 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.29 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.30 Use API/Webhook to write to the field 'Message'
You need two keys to use our API - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.
API key:
*Go to 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: Go to Settings > Properties > Access > propKey = secret_key_for_prop_XXXXXX
11 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.