ECAL Booking Reminders
In this Article:
View in Postman collectionPre-requisites
- Create an ECAL Account and Schedule
- Log into your ECAL Account and follow the prompts in the ‘Getting Started Guide’ to create a schedule that can be used for general messages (optional)
- Register your Webhook endpoint to capture the User’s subscription details (e.g. email & ecal_id) as they subscribe to Event Booking Reminders.
- Log into your ECAL Account and follow the prompts in the ‘Getting Started Guide’ to create a schedule that can be used for general messages (optional)
- Configure Button Display
The Button Display must be configured so that it does not show any Schedules
- All Button Displays for your private schedule service must have the Welcome Message enabled, so your subscribers receive an instant ‘success’ message in calendar when they subscribe.
- To enable the ‘Welcome Message’ go to the ‘Options’ tab in the ’edit’ section of the Button Display.
- Scroll down and toggle-off the option to disable Sharing. This is a direct and personal subscription and sharing is not necessary.
- Once created, ensure your button is set to ‘Live’
- Publish your ECAL ‘Sync to Calendar’ Button so users can subscribe to receive private events into their personal calendar
- Publish your ECAL ‘Sync to Calendar’ Button following the instructions here
- Use ECAL’s Private Event API to publish events to User’s calendar
Event Booking Reminder - Confirmed Sample Messaging
Event Booking Reminders deliver your subscriber useful information about their booking, like confirmation or reference numbers, venue/ location and other important details about the booking.
Set up your own Confirmed Booking Reminders by following the template below:
| API Field | Description | Type | Required | Example | Notes |
|---|---|---|---|---|---|
| type | Event Type | string | YES | Private | |
| name | Title | string | YES | 🏡 Booking Confirmed: Your cosy, family hideaway in Noosa Heads | ⚡️ Tip: It’s a great idea to insert an emoji at the start of the title, to make the event standout in calendar! |
| location | Location/Venue of your Event | string | YES | 1 Edgar Bennett Avenue 102, Noosa Heads, QLD 4567, Australia | |
| startDate | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/01 | |
| startTime | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘YES’. |
time | CONDITIONAL | 15:00 | |
| endDate | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/01 | |
| endTime | The end time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘YES’. |
time | CONDITIONAL | 15:30 | |
| allDay | If start/end times are provided ‘allday’ is ’no’. | string | NO | “no” | |
| timezone | Timezone of your Event | string/enum | NO | Australia/Brisbane | ⚡️ Tip: Local event time is a good way to go, or use a standard timezone throughout (eg: GMT). |
| alert1 | The initial reminder alert for the event before its due. The valid values are |
string/enum | NO | 5D | ⚡️ Tip: Set the reminders at the appropriate booking or decision window for your particular event! |
| alert2 | The secondary reminder alert for the event before its due. The valid values are |
string/enum | NO | 2D | |
| details | Description / comments about the event | string | NO | Hi Bethaney, You’re all set for Noosa Heads. Confirmation Code: HMJKN824R2 Centrally positioned between Noosa’s entertainment hub, placed literally a five minute walking distance either way to prestigious Hastings Street or Noosa Junction this location is perfect for your Noosa escape. You’ll find instructions to get inside your booking property 48 hours before check-in. Hosted by Michael & Kana |
⚡️ Tip: Provide as much relevant information you can about this event, to inform your audience. EG: include an event description, a strong ‘call to action’, booking details, ticket pricing, ticket status, TV broadcast information etc. |
| sponsored_message | Additional messaging (120 char. limit) eg: Sponsor mention, special offer, offer code etc. | string | NO | 🛶 Receieve 25% off total purchase price when Kayaking the secret waterways full of Stingrays. https://www.airbnb.com.au/experiences/1609435?source=place_pdp | |
| quickLink[1] [name] | The name quicklink 1 | string | NO | View Listing | ⚡️ Tip: Quick Links will appear within the event details section of your calendar event. They are an amazing way to drive engagement and sales around your event! |
| quickLink[1] [url] | The url of the quicklink 1 | string | NO | https://www.airbnb.com.au/rooms/49195700? | |
| quickLink[2] [name] | The name quicklink 2 | string | NO | Contact Host | |
| quickLink[2] [url] | The url of the quicklink 2 | string | NO | https://www.airbnb.com.au/contact_host/49195700/send_message | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. |
| quickLink[3] [name] | The name quicklink 3 | string | NO | Cancellation Policy | |
| quickLink[3] [url] | The url of the quicklink 3 | string | NO | https://www.airbnb.com.au/help/article/149/find-the-cancellation-policy-for-your-stay | |
| Social Links | array | NO | https://www.facebook.com/airbnb | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. | |
| Social Links | array | NO | https://www.instagram.com/airbnb/ | ||
| reference | Unique reference of the event, provided by you | string | YES | ||
| draft | Set this to 0 to push the event live. Defaults to 1 | bit | NO |
Event Booking Reminder - Tactical Sample Messaging
Tactical marketing entries provide opportunities to drive further engagement with your users.
Set up your own tactical marketing entries by following the sample messaging below:
| API Field | Description | Type | Required | Example | Notes |
|---|---|---|---|---|---|
| type | Event Type | string | YES | Private | |
| name | Title | string | YES | Crikey! Visit the iconic Australia Zoo during your stay at Noosa Heads 🐊 |
⚡️ Tip: It’s a great idea to insert an emoji at the start of the title, to make the event standout in calendar! |
| location | Location/Venue of your Event | string | YES | Steve Irwin Way, Beerwah QLD 4519 | |
| startDate | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/24 | |
| startTime | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘YES’. | time | CONDITIONAL | 12:00 | |
| endDate | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/24 | |
| endTime | The end time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘YES’. | time | CONDITIONAL | 12:30 | |
| allDay | If start/end times are provided ‘allday’ is ’no’. | string | NO | “no” | |
| timezone | Timezone of your Event | string/enum | NO | Australia/Brisbane | ⚡️ Tip: Local event time is a good way to go, or use a standard timezone throughout (eg: GMT). |
| alert1 | The initial reminder alert for the event before its due. The valid values are | string/enum | NO | 15M | ⚡️ Tip: Set the reminders at the appropriate booking or decision window for your particular event! |
| alert2 | The secondary reminder alert for the event before its due. The valid values are | string/enum | NO | ||
| details | Description / comments about the event | string | NO | Hi Bethaney, Visit Australia’s most iconic zoo during your stay at Noosa Heads and receive 25% off your total ticket purchase. Use your personalised confiormation code HMJKN824R2 to redeem this special offer and follow the link below. |
⚡️ Tip: Provide as much relevant information you can about this event, to inform your audience. EG: include an event description, a strong ‘call to action’, booking details, ticket pricing, ticket status, TV broadcast information etc. |
| sponsored_message | Additional messaging (120 char. limit) eg: Sponsor mention, special offer, offer code etc. | string | NO | ||
| quickLink[1] [name] | The name quicklink 1 | string | NO | Buy Tickets | ⚡️ Tip: Quick Links will appear within the event details section of your calendar event. They are an amazing way to drive engagement and sales around your event! |
| quickLink[1] [url] | The url of the quicklink 1 | string | NO | https://onlinesales.centaman.net/AustraliaZoo/BuyTickets | |
| quickLink[2] [url] | The url of the quicklink 1 | string | NO | ||
| quickLink[3] [url] | The url of the quicklink 1 | string | NO | ||
| Social Links | array | NO | https://twitter.com/AustraliaZoo | ||
| Social Links | array | NO | https://www.instagram.com/australiazoo/ | ||
| reference | Unique reference of the event, provided by you | string | YES | ||
| draft | Set this to 0 to push the event live. Defaults to 1 | bit | NO |
Event Booking Reminder - Status Change Sample Messaging
Status Change Booking Reminders deliver your subscriber useful information changes about their Booking.
Set up your own Status Change Booking Reminders by following the template below:
| API Field | Description | Type | Required | Example | Notes |
|---|---|---|---|---|---|
| type | Event Type | string | YES | Private | |
| name | Title | string | YES | ⚠️ Booking Cancelled: Cosy, family hideaway in Noosa Heads | ⚡️ Tip: It’s a great idea to insert an emoji at the start of the title, to make the event standout in calendar! |
| location | Location/Venue of your Event | string | YES | 1 Edgar Bennett Avenue 102, Noosa Heads, QLD 4567, Australia | |
| startDate | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/01 | |
| startTime | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘YES’. | time | CONDITIONAL | 15:00 | |
| endDate | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/01 | |
| endTime | The end time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘YES’. | time | CONDITIONAL | 15:30 | |
| allDay | If start/end times are provided ‘allday’ is ’no’. | string | NO | “no” | |
| timezone | Timezone of your Event | string/enum | NO | Australia/Brisbane | ⚡️ Tip: Local event time is a good way to go, or use a standard timezone throughout (eg: GMT). |
| alert1 | The initial reminder alert for the event before its due. The valid values are | string/enum | NO | 5D | ⚡️ Tip: Set the reminders at the appropriate booking or decision window for your particular event! |
| alert2 | The secondary reminder alert for the event before its due. The valid values are | string/enum | NO | 2D | |
| details | Description / comments about the event | string | NO | Hi Bethaney, Unfortunately, your host has had to cancel your stay. Confirmation Code: HMJKN824R2 Search for more properties in Noosa Heads by following the below link. |
⚡️ Tip: Provide as much relevant information you can about this event, to inform your audience. EG: include an event description, a strong ‘call to action’, booking details, ticket pricing, ticket status, TV broadcast information etc. |
| sponsored_message | Additional messaging (120 char. limit) eg: Sponsor mention, special offer, offer code etc. | string | NO | ||
| quickLink[1] [name] | The name quicklink 1 | string | NO | Search for more properties in Noosa Heads | ⚡️ Tip: Quick Links will appear within the event details section of your calendar event. They are an amazing way to drive engagement and sales around your event! |
| quickLink[1] [url] | The url of the quicklink 1 | string | NO | https://www.airbnb.com.au/a/stays/Noosa-Heads–Queensland–Australia? | |
| quickLink[2] [name] | The name quicklink 2 | string | NO | Cancellation Policy | |
| quickLink[2] [url] | The url of the quicklink 2 | string | NO | https://www.airbnb.com.au/help/article/149/find-the-cancellation-policy-for-your-stay | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. |
| quickLink[3] [name] | The name quicklink 3 | string | NO | ||
| quickLink[3] [url] | The url of the quicklink 3 | string | NO | ||
| Social Links | array | NO | https://www.facebook.com/airbnb | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. | |
| Social Links | array | NO | https://www.instagram.com/airbnb/ | ||
| reference | Unique reference of the event, provided by you | string | YES | ||
| draft | Set this to 0 to push the event live. Defaults to 1 | bit | NO |