ECAL My Travel Itinerary
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 for My Favourites
- 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
- Exit Advertising
Choose your Exit Advertising for your Display. You can opt to upload an Ad Unit with a clickable URL. The Exit Advertising appears to your subscriber once they have subscribed successfully to the service.
- Welcome Message
- 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
Itinerary Reminders - Travel Dates Sample Reminders
Send important post purchase travel reminders directly into the calendar of your subscribers;
N:B Any changes to the event will be automatically updated in subscribers calendar.
1. Itinerary Reminder Sample:
Set up your own Travel Date Reminders by following the template(s) below:
| API Field | Description | Type | Required | Example | |
|---|---|---|---|---|---|
| “type” | Event Type | string | YES | Private | |
| “name” | Title | string | YES | 🛫 Scoot Flight TR392 Gold Coast to Singapore | ⚡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 | Gold Coast Airport Terminal 3 | |
| “startDate” | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/30 | |
| “startTime” | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 11:30 | |
| “endDate” | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/30 | |
| “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:00 | |
| “allDay” | If start/end times are provided, ‘allday’ is ’no’. | string | NO | “no” | |
| “timezone” | Timezone of your Event. | string/enum | NO | Australia/Melbourne | ⚡️ Tip: Local event time is a good way to go, or use a standard time zone throughout (e.g.: GMT). |
| “alert1” | The initial reminder alert for the event before its due. | string/enum | NO | 3H | ⚡️ 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. | string/enum | NO | 3D | |
| “details” | Description / comments about the event | string | NO | You are booked and ready for the scheduled TR391 service from Gold Coast to Singapore. Scoot Booking Reference: W5NJYV heck-in closes 30 minutes prior We recommend that you be at the airport at least 90 minutes before departure time. Extra time would need to be considered in case of congestion at the airport. |
⚡️ 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) e.g.: Sponsor mention, special offer, offer code etc. | string | NO | Book your Gold Coast Airport parking online to secure the closest, most convenient onsite parking options at competitive prices. https://ql.e-c.al/GCAparking | |
| “quickLink[1] [name]” | The name quicklink 1 | string | NO | Online Check-in | ⚡️ 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.flyscoot.com/en | |
| “quickLink[2] [name]” | The name quicklink 2 | string | NO | Manage Booking | |
| “quickLink[2] [url]” | The url of the quicklink 2 | string | NO | https://www.flyscoot.com | ⚡️ 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 | Gold Coast Airport Parking | |
| “quickLink[3] [url]” | The url of the quicklink 3 | string | NO | https://www.goldcoastairport.com.au/parking-transport/gold-coast-airport-parking | |
| “quickLink[4] [name]” | The name quicklink 4 | string | NO | Ground Transport | |
| “quickLink[4] [url]” | The url of the quicklink 4 | string | NO | https://www.goldcoastairport.com.au/parking-transport/transport | |
| “facebook” | Social Links | array | NO | https://www.facebook.com/goldcoastairport/ | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. |
| “twitter” | Social Links | array | NO | https://twitter.com/gcairport | |
| “instagram” | Social Links | array | NO | ||
| “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 |
2. Itinerary Reminder Sample:
Set up your own Travel Date Reminders by following the template(s) below:
| API Field | Description | Type | Required | Example | |
|---|---|---|---|---|---|
| “type” | Event Type | string | YES | Private | |
| “name” | Title | string | YES | 🛬 Scoot Flight TR391 Singapore to Gold Coast | ⚡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 | Changi Airport Terminal 1 | |
| “startDate” | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/03 | |
| “startTime” | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 11:30 | |
| “endDate” | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/03 | |
| “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:00 | |
| “allDay” | If start/end times are provided, ‘allday’ is ’no’. | string | NO | “no” | |
| “timezone” | Timezone of your Event. | string/enum | NO | Australia/Melbourne | ⚡️ Tip: Local event time is a good way to go, or use a standard time zone throughout (e.g.: GMT). |
| “alert1” | The initial reminder alert for the event before its due. | string/enum | NO | 3H | ⚡️ 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. | string/enum | NO | 1D | |
| “details” | Description / comments about the event | string | NO | You are booked and ready for the scheduled TR392 service from Singapore to Gold Coast. Scoot Booking Reference: W5NJYV Check-in time: 10:00am Check-in closes 30 minutes prior We recommend that you be at the airport at least 90 minutes before departure time. Extra time would need to be considered in case of congestion at the airport. |
⚡️ 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) e.g.: Sponsor mention, special offer, offer code etc. | string | NO | ||
| “quickLink[1] [name]” | The name quicklink 1 | string | NO | Online Check-in | ⚡️ 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.flyscoot.com/en | |
| “quickLink[2] [name]” | The name quicklink 2 | string | NO | Manage Booking | |
| “quickLink[2] [url]” | The url of the quicklink 2 | string | NO | https://www.flyscoot.com | ⚡️ 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 | Gold Coast Car Hire | |
| “quickLink[3] [url]” | The url of the quicklink 3 | string | NO | https://www.goldcoastairport.com.au/parking-transport/gold-coast-airport-parking | |
| “quickLink[4] [name]” | The name quicklink 4 | string | NO | Shopping & Dining | |
| “quickLink[4] [url]” | The url of the quicklink 4 | string | NO | https://www.goldcoastairport.com.au/shopping | |
| “facebook” | Social Links | array | NO | https://www.facebook.com/goldcoastairport/ | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. |
| “twitter” | Social Links | array | NO | https://twitter.com/gcairport | |
| “instagram” | Social Links | array | NO | ||
| “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 |
Itinerary Tactical Reminders - Sample Affiliate Partner
Use tactical reminders to promote affiliate partners and drive further calls to action with your audience:
Set up your own Travel Date Reminders by following the template(s) below:
| API Field | Description | Type | Required | Example | |
|---|---|---|---|---|---|
| “type” | Event Type | string | YES | Private | |
| “name” | Title | string | YES | 🚗 Book your Gold Coast Airport parking now! | ⚡️ 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 | See entry for details👇 | |
| “startDate” | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/28 | |
| “startTime” | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 10:00 | |
| “endDate” | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/28 | |
| “endTime” | The end time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 10:20 | |
| “allDay” | If start/end times are provided, ‘allday’ is ’no’. | string | NO | “no” | |
| “timezone” | Timezone of your Event | string/enum | NO | Australia/Melbourne | ⚡️ Tip: Local event time is a good way to go, or use a standard time zone throughout (e.g.: GMT). |
| “alert1” | The initial reminder alert for the event before its due. | string/enum | NO | 5M | ⚡️ 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. | string/enum | NO | ||
| “details” | Description / comments about the event | string | NO | Hi Jarad, your trip to Singapore is almost here! Are you ready? Whether you’re arriving or departing there’s nothing better than having your car close by. At Gold Coast Airport, no airport parking is closer - making your journey shorter and easier. Book your Gold Coast Airport parking online to secure the closest, most convenient onsite parking options at competitive prices. Use code SCOOT at checkout to receive 10% off. |
⚡️ 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) e.g.: Sponsor mention, special offer, offer code etc. | string | NO | ||
| “quickLink[1] [name]” | The name quicklink 1 | string | NO | Book Now | ⚡️ 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://prebook.goldcoastairport.com.au/en/ | |
| “quickLink[2] [name]” | The name quicklink 2 | string | NO | Parking Information | |
| “quickLink[2] [url]” | The url of the quicklink 2 | string | NO | https://www.goldcoastairport.com.au/parking-transport/gold-coast-airport-parking | ⚡️ 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 | ||
| “quickLink[4] [name]” | The name quicklink 4 | string | NO | ||
| “quickLink[4] [url]” | The url of the quicklink 4 | string | NO | ||
| “facebook” | Social Links | array | NO | https://www.facebook.com/goldcoastairport/ | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. |
| “twitter” | Social Links | array | NO | https://twitter.com/gcairport | |
| “instagram” | Social Links | array | NO | ||
| “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 |