onEventReminder( )

A backend event that fires when a Wix event's reminders are sent.

Description

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.

Syntax

function onEventReminder(event: EventReminder): void

onEventReminder Parameters

NAME

TYPE

DESCRIPTION

event

EventReminder

Information about the event that the reminder was sent for.

Returns

This function does not return anything.

Return Type:

void

Was this helpful?

A backend event that occurs when a Wix event's reminders are sent

Copy Code

1// Place this code in the events.js file
2// of your site's Backend section.  
3// Add the file if it doesn't exist.
4
5export function wixEvents_onEventReminder(event) {
6  let eventId = event.eventId;
7  let title = event.title;
8}
9
10/*  Full event object:
11 *  {
12 *    "timestamp": "2020-04-26T13:57:50.699Z",
13 *    "eventId": "46dc2337-d725-4f7e-a0ae-a94a9a1f0c0b",
14 *    "location": {
15 *      "name": "Wix Playground",
16 *      "coordinates": {
17 *        "lat": 40.739254,
18 *        "lng": -74.008925
19 *      },
20 *      "address": "100 Gansevoort St, New York, NY 10014, USA",
21 *      "type": "VENUE"
22 *    },
23 *    "scheduleConfig": {
24 *      "scheduleTbd": false,
25 *      "scheduleTbdMessage": "",
26 *      "startDate": "2020-05-10T16:00:00.000Z",
27 *      "endDate": "2020-05-10T20:00:00.000Z",
28 *      "timeZoneId": "EST"
29 *    },
30 *    "title": "My event",
31 *    "userId": "01cb99e2-e969-421a-b65f-43bea2a66fa1",
32 *    "startsIn": {
33 *      "days": 3,
34 *      "hours": 0,
35 *      "minutes": 0
36 *    }
37 *  }
38 */