ECAL Appointment 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 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
Appointment Reminders - Sample Reminder Template
Appointment Reminders deliver your subscriber useful information about their booking, like confirmation or reference numbers, venue/ location and other important details about the booking.
1. Consultation Confirmation
Set up your own Consultation Confirmation by following the template below:
| API Field | Description | Type | Required | Example | |
|---|---|---|---|---|---|
| “type” | Event Type | string | YES | Private | |
| “name” | Title | string | YES | Your Celebrity Ink Consultation is today! | ⚡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 | The Paradise Centre, 066/2 Cavill Ave, Surfers Paradise QLD 4217 | |
| “startDate” | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/14 | |
| “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:20 | |
| “endDate” | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/14 | |
| “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/Brisbane | ⚡️ 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 | 2H | ⚡️ 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 | 2D | |
| “details” | Description / comments about the event | string | NO | Hi Pat, Your initial Celebrity Ink consultation is today at 11:20am. Our experienced artists will help answer all your questions so you can be confident taking the next step towards telling your story through ink. Please arrive 10 minutes before your appointment time and quote your booking no. PAT23890 Check out our Ultimate Tattoo Style Guide to learn more about the different tattoos and their history, or visit our Pinterest to browse and pin your favourites. |
⚡️ 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 | Ultimate Tattoo Style Guide | ⚡️ 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.celebrityink.com/ultimate-tattoo-style-guide-examples-tattoos/ | |
| “quickLink[2] [name]” | The name quicklink 2 | string | NO | Frequently Asked Questions | |
| “quickLink[2] [url]” | The url of the quicklink 2 | string | NO | https://celebrityink.com/faqs/tattoo-questions/ | ⚡️ 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 | Celebrity Ink Surfers Paradise | |
| “quickLink[3] [url]” | The url of the quicklink 3 | string | NO | https://celebrityink.com/locations/surfers-paradise/ | |
| “quickLink[4] [name]” | The name quicklink 4 | string | NO | ||
| “quickLink[4] [url]” | The url of the quicklink 4 | string | NO | https://www.pinterest.com.au/celebrityink_/ | |
| “facebook” | Social Links | array | NO | https://www.facebook.com/celebrityinktattoosurfersparadise | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. |
| “twitter” | Social Links | array | NO | https://www.instagram.com/celebrityinksurfersparadise | |
| “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. Booking Confirmation
Set up your own Booking Confirmation by following the template below:
| API Field | Description | Type | Required | Example | |
|---|---|---|---|---|---|
| “type” | Event Type | string | YES | Private | |
| “name” | Title | string | YES | 🔥 Your Celebrity Ink Tattoo Booking is today! | ⚡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 | The Paradise Centre, 066/2 Cavill Ave, Surfers Paradise QLD 4217 | |
| “startDate” | The start date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/20 | |
| “startTime” | The start time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 9:00 | |
| “endDate” | The end date of the event. Must be in YYYY-MM-DD format | date | YES | 2022/12/20 | |
| “endTime” | The end time of the event. Must be in HH:MM 24hr format. Required unless ‘allDay’ field is set to ‘yes’. | time | CONDITIONAL | 11:00 | |
| “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 time zone throughout (e.g.: GMT). |
| “alert1” | The initial reminder alert for the event before its due. | string/enum | NO | 2H | ⚡️ 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 | Hi Pat, Today is the day you will tell your story. Your tattoo is locked in for 9:00am. Please arrive 10 minutes prior to your appointment time. Getting your first tattoo can be both exciting and pretty scary! To prepare yourself for this amazing experience, talk to friends and family members who have had tattoos and get their thoughts. |
⚡️ 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 | Tattoo Questions | ⚡️ 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://celebrityink.com/faqs/tattoo-questions/ | |
| “quickLink[2] [name]” | The name quicklink 2 | string | NO | Booking, Cancellation & Refunds Policy | |
| “quickLink[2] [url]” | The url of the quicklink 2 | string | NO | https://celebrityink.com/cancellation-policy/ | ⚡️ 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 | Join the Inked Crew | |
| “quickLink[3] [url]” | The url of the quicklink 3 | string | NO | https://celebrityink.com/ | |
| “facebook” | Social Links | array | NO | https://www.facebook.com/celebrityinktattoosurfersparadise | ⚡️ Tip: Add links to your popular social pages, communities and apps, incl. Facebook, Twitter, Instagram etc. |
| “twitter” | Social Links | array | NO | https://www.instagram.com/celebrityinksurfersparadise | |
| “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 |