A backend event that fires when a Wix event's reminders are sent.
The onEventReminder()
event handler runs when a Wix event is set to have a reminder
and the time of the reminder arrives.
The received EventReminder
object contains information about the event.
Configure when the reminder is sent in the site dashboard.
Note: Backend events are not fired when previewing your site.
function onEventReminder(event: EventReminder): void;
Information about the event that the reminder was sent for.
// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.
export function wixEvents_onEventReminder(event) {
let eventId = event.eventId;
let title = event.title;
}
/* Full event object:
* {
* "timestamp": "2020-04-26T13:57:50.699Z",
* "eventId": "46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b",
* "location": {
* "name": "Wix Playground",
* "coordinates": {
* "lat": 40.739254,
* "lng": -74.008925
* },
* "address": "100 Gansevoort St, New York, NY 10014, USA",
* "type": "VENUE"
* },
* "scheduleConfig": {
* "scheduleTbd": false,
* "scheduleTbdMessage": "",
* "startDate": "2020-05-10T16:00:00.000Z",
* "endDate": "2020-05-10T20:00:00.000Z",
* "timeZoneId": "EST"
* },
* "title": "My event",
* "userId": "01cb99e2-e969-421a-b65f-43bea2a66fa1",
* "startsIn": {
* "days": 3,
* "hours": 0,
* "minutes": 0
* }
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.