ECAL My Favourites
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
- 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
My Favourites - Sample Messaging
Utilise ECAL’s Private Events API to deliver rich personalised selected event information directly into your subscribers calendar.
Set up your own My Favourites entries by following the sample messaging below:
| API Field | Description | Type | Required | Example | Notes |
|---|---|---|---|---|---|
| type | Event Type | string | YES | Private | |
| name | Title | string | YES | 🥘 New Season of MasterChef - S14 Ep. 01 is airing tonight! | ⚡️ 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 | Watch on 10Play | |
| startDate | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/22 | |
| startTime | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 19:30:00 PM | |
| endDate | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/22 | |
| endTime | The end time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 20:45:00 PM | |
| 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 timezone throughout (eg: GMT). |
| alert1 | The initial reminder alert for the event before its due. | string/enum | NO | 1D | ⚡️ 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 | 15M | |
| details | Description / comments about the event | string | NO | Hi Bethaney, You won’t miss a thing with My Favourites! Returning for its 14th remarkable season in 2022, MasterChef Australia is must- see TV with brand new judges and returning contestants. Watch it live NOW by following 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 | Win 1 of 10 $10,000 travel vouchers with Lite n’ Easy. Experience the Flavours of the World on our NEW Winter Menu |
|
| quickLink[1] [name] | The name quicklink 1 | string | NO | Watch 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://10play.com.au/masterchef | |
| quickLink[2] [name] | The name quicklink 2 | string | NO | Lite n’ Easy MasterChef | |
| quickLink[2] [url] | The url of the quicklink 2 | string | NO | https://www.liteneasy.com.au/ | ⚡️ 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/Channel10 | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. | |
| Social Links | array | NO | https://www.instagram.com/channel10au | ||
| 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 |
My Favourites- 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 | 🏝 New Season of Survivor US Season 41 starts BRAINS VS BRAWN starts next week! | ⚡️ 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 | Watch on 10Play | |
| startDate | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/23 | |
| startTime | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 20:00 | |
| endDate | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/11/23 | |
| endTime | The end time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 20:05 | |
| 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 timezone throughout (eg: GMT). |
| alert1 | The initial reminder alert for the event before its due. | 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. | string/enum | NO | ||
| details | Description / comments about the event | string | NO | Hi Bethaney, Love reality TV like Masterchef? Check out the brand new season of BRAINS vs BRAWN by following the link below for an exclusive sneak premiering 30.11.22 at 8pm AEST. |
⚡️ 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 | Win 1 of 10 $10,000 travel vouchers with Lite n’ Easy. Experience the Flavours of the World on our NEW Winter Menu | |
| quickLink[1] [name] | The name quicklink 1 | string | NO | 10Play Home | ⚡️ 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://10play.com.au/survivor/sneakpeek | |
| quickLink[2] [name] | The name quicklink 2 | string | NO | Lite n’ Easy Survivor | |
| quickLink[2] [url] | The url of the quicklink 2 | string | NO | https://www.liteneasy.com.au/ | ⚡️ 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/Channel10 | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. | |
| Social Links | array | NO | https://www.instagram.com/channel10au/ | ||
| 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 |