> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Package: registration # Namespace: eventGuests # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/event-guests/guest-event-canceled.md ## Introduction Triggered when an event is canceled. --- ## REST API ### Schema ``` Webhook: Guest Event Canceled Description: Triggered when an event is canceled. Event body: - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events. - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event. - name: slug | type: string | description: Event name. - name: entityId | type: string | description: ID of the entity associated with the event. - name: eventTime | type: string (date-time) | description: Event timestamp. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR. - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: actionEvent | type: object | description: Custom action event details. - name: body | type: GuestEventCanceled | description: The event body. - name: guest | type: EventGuest | description: Event guest. - name: id | type: string | description: Guest GUID. - name: eventId | type: string | description: Event GUID. - name: rsvpId | type: string | description: RSVP GUID.

**Note:** Only applicable when `guestType` is `"RSVP"`. - name: orderNumber | type: string | description: Order number.

**Note:** Only applicable when `guestType` is `"BUYER"` or `"TICKET_HOLDER"`. - name: ticketNumber | type: string | description: Ticket number.

**Note:** Only applicable when `guestType` is `"TICKET_HOLDER"`. - name: tickets | type: array | description: List of names, numbers, and definition GUIDs for each ticket. - name: number | type: string | description: Ticket number. - name: definitionId | type: string | description: Ticket definition GUID. - name: name | type: string | description: Ticket name. - name: contactId | type: string | description: Guest's contact GUID. See the Contacts API for more details. - name: guestDetails | type: GuestDetails | description: Guest details.

Returned only when the `guestDetails` fieldset is sent in the request. - name: email | type: string | description: Email. - name: firstName | type: string | description: First name. - name: lastName | type: string | description: Last name. - name: formResponse | type: FormResponse | description: Form response. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: checkedIn | type: boolean | description: Whether the guest has checked into the event. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: The login details for the guest to access the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: phone | type: string | description: Phone extracted from form response. If multiples phone inputs are present, first one is returned. - name: address | type: string | description: Address extracted from form response. If multiples address inputs are present, first one is returned. - name: attendanceStatus | type: AttendanceStatus | description: Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information, see [Guest Attendance Status Mapping](https://dev.wix.com/docs/api-reference/business-solutions/events/registration/event-guests/guest-attendance-status-mapping.md).

**Note:** For `guestType` of `"BUYER"` or `"TICKET_HOLDER"` the `"IN_WAITLIST"` value is not applicable. - enum: - NOT_ATTENDING: Not attending. - ATTENDING: Attending. - IN_WAITLIST: In a waiting list. - name: secondaryLanguageCode | type: string | description: Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. - name: createdDate | type: string | description: Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. - name: updatedDate | type: string | description: Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. - name: attendanceStatusUpdatedDate | type: string | description: Date and time of guest's latest attendance status update. - name: memberId | type: string | description: Site member GUID. - name: guestType | type: GuestType | description: Guest type. - enum: - RSVP: An invited guest, no ticket necessary. - BUYER: The guest who bought the ticket. - TICKET_HOLDER: The guest for whom the ticket was bought. - name: locale | type: string | description: Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale. - name: totalGuests | type: integer | description: Number of total guests in an event (registered guests + additional ones). - name: revision | type: string | description: Revision number, which increments by 1 each time the guest is updated. - name: additionalDetails | type: AdditionalDetails | description: Additional Details - name: createdDate | type: string | description: Date and time the source entity (RSVP or Order) was created. - name: updatedDate | type: string | description: Date and time the source entity (RSVP or Order) was updated. - name: rsvpStatus | type: RsvpStatus | description: Rsvp Status - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: orderStatus | type: OrderStatus | description: Order Status - enum: - UNKNOW_ORDER_STATUS: Order status is not available for this request fieldset. - FREE: Order is confirmed, no payment is required. - PENDING: Order was paid, but the payment gateway suspended the payment. - PAID: Order is paid. - OFFLINE_PENDING: Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. - INITIATED: Order is awaiting for payment at the cashier. - CANCELED: Order is canceled. - DECLINED: Order payment is declined. - AUTHORIZED: Order payment is authorized. - VOIDED: Order payment is voided. - PARTIALLY_PAID: Order is partially paid with less than the total amount. - name: event | type: EventDetails | description: Event context. - name: title | type: string | description: Event title. - name: shortDescription | type: string | description: Event short description. - name: location | type: Location | description: Event location. - name: name | type: string | description: Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. - name: type | type: LocationType | description: Location type. - enum: - VENUE: Event is on-site at a specific physical location. - ONLINE: Event is online, such as a virtual video conference. - name: address | type: Address | description: Exact location address. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street address. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Primary address information (street and building number). - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). - name: city | type: string | description: City name. - name: postalCode | type: string | description: Zip or postal code. - name: addressLine2 | type: string | description: Secondary address information (suite or apartment number and room number). - name: locationTbd | type: boolean | description: Whether the event location is TBD. - name: dateAndTimeSettings | type: DateAndTimeSettings | description: Event date and time settings. - name: dateAndTimeTbd | type: boolean | description: Whether the event date and time are TBD. - name: dateAndTimeTbdMessage | type: string | description: Message that is displayed when time and date is TBD. **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`. - name: startDate | type: string | description: Event start date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: endDate | type: string | description: Event end date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: timeZoneId | type: string | description: Event time zone GUID in the [TZ database](https://www.iana.org/time-zones) format. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: hideEndDate | type: boolean | description: Whether the end date is hidden in the formatted date and time. - name: showTimeZone | type: boolean | description: Whether the time zone is displayed in the formatted schedule. - name: recurrenceStatus | type: Status | description: Repeating event status. - enum: - ONE_TIME: Event happens only once and can last multiple days. - RECURRING: A series of events that repeat. - RECURRING_UPCOMING: Next event in a schedule of recurring events. - RECURRING_RECENTLY_ENDED: Latest event that ended in a schedule of recurring events. - RECURRING_RECENTLY_CANCELED: Latest canceled event in a schedule of recurring events - name: recurringEvents | type: Recurrences | description: Event repetitions. - name: individualEventDates | type: array | description: Individual event dates for recurring events. *Note:** Each date must be manually calculated and provided. There is no support for automatic generation using recurrence rules or patterns (for example, "Weekly"). When you create a recurring event: - Each occurrence is created as an independent event with its own unique GUID. - All occurrences in the series share the same `categoryId`, which allows you to identify all events in the recurring series. - To retrieve all events in a recurring series, query events by `recurringEvents.categoryId`. - Each event in the series can be independently updated or deleted using its individual event GUID. - name: startDate | type: string | description: Event start date. - name: endDate | type: string | description: Event end date. - name: timeZoneId | type: string | description: Event time zone GUID in the [TZ database](https://www.iana.org/time-zones) format. - name: showTimeZone | type: boolean | description: Whether the time zone is displayed in a formatted schedule. - name: categoryId | type: string | description: Recurring event category GUID. This read-only field is automatically generated and shared by all events in a recurring series. Use this GUID to query and retrieve all occurrences of a recurring event. - name: formatted | type: Formatted | description: Formatted date and time settings. - name: dateAndTime | type: string | description: Formatted date and time representation.
Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`. - name: startDate | type: string | description: Formatted start date of the event. Empty for TBD schedules. - name: startTime | type: string | description: Formatted start time of the event. Empty for TBD schedules. - name: endDate | type: string | description: Formatted end date of the event. Empty for TBD schedules or when the end date is hidden. - name: endTime | type: string | description: Formatted end time of the event. Empty for TBD schedules or when the end date is hidden. - name: eventPageUrl | type: PageUrl | description: Event page URL components. - name: base | type: string | description: The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`). - name: path | type: string | description: The path to the page. For example, `/product-page/a-product`. - name: status | type: Status | description: Event status. - enum: - UPCOMING: Event is published and scheduled to start. - STARTED: Event has started. - ENDED: Event has ended. - CANCELED: Event is canceled. - DRAFT: Event is not public. ``` ### Examples ```curl { "id": "b68ad24b-2abf-4478-b176-06a46639d1bd", "entityFqdn": "wix.events.guests.v1.guest", "slug": "guest_event_canceled", "entityId": "e1a7ff2e-14a5-4f5b-be5a-5319f0dd11dd", "actionEvent": { "bodyAsJson": { "guest": { "id": "501554db-e150-404b-95ae-94ef636f4a7f", "eventId": "23dbadaa-4a54-41df-ad3f-9f37405bb3b3", "orderNumber": "2X32-W2MV-4RF", "ticketNumber": "2X32-W2MV-4RF1P", "tickets": [ { "number": "2X32-W2MV-4RF1P", "definitionId": "158f5d74-0bce-4adb-9868-4dc513e7e001", "name": "Early Bird", "guestDetails": {} } ], "contactId": "53a6179d-5ab2-4de4-a6a2-1fa10ebc3dff", "guestDetails": { "checkedIn": false }, "attendanceStatus": "ATTENDING", "createdDate": "2024-12-21T14:38:28.274Z", "updatedDate": "2024-12-21T14:38:28.399Z", "attendanceStatusUpdatedDate": "2024-12-21T14:38:26.386Z", "guestType": "TICKET_HOLDER", "totalGuests": 1, "revision": "2" }, "event": { "title": "Wine and Music", "shortDescription": "Wine and music will make for an awesome date night or friends night out.", "location": { "name": "Bar", "type": "VENUE", "address": { "country": "US", "subdivision": "GA", "city": "Atlanta", "postalCode": "00000-0000", "streetAddress": { "number": "1531", "name": "Street Road", "apt": "a" }, "formattedAddress": "1531 Street Rd NW Ste A, Atlanta, GA 00000, USA", "geocode": { "latitude": 14.7972603, "longitude": -102.4158137 }, "countryFullname": "United States", "subdivisions": [ { "code": "GA", "name": "Georgia", "type": "ADMINISTRATIVE_AREA_LEVEL_1" }, { "code": "Fulton County", "name": "Fulton County", "type": "ADMINISTRATIVE_AREA_LEVEL_2" }, { "code": "Atlanta", "name": "Atlanta", "type": "ADMINISTRATIVE_AREA_LEVEL_3" }, { "code": "US", "name": "United States", "type": "COUNTRY" } ] }, "locationTbd": false }, "dateAndTimeSettings": { "dateAndTimeTbd": false, "startDate": "2025-01-04T20:00:00Z", "endDate": "2025-01-04T22:00:00.235Z", "timeZoneId": "America/New_York", "hideEndDate": false, "showTimeZone": true, "recurrenceStatus": "ONE_TIME", "recurringEvents": { "individualEventDates": [] }, "formatted": { "dateAndTime": "January 4, 2025, 3:00 – 5:00 PM EST", "startDate": "January 4, 2025", "startTime": "3:00 PM", "endDate": "January 4, 2025", "endTime": "5:00 PM" } }, "eventPageUrl": { "base": "https://www.wix-site.com", "path": "/event-details/wine-and-music" }, "status": "CANCELED" } } }, "eventTime": "2025-01-02T14:14:30.322949200Z", "triggeredByAnonymizeRequest": false } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onGuestEventCanceled Description: Triggered when an event is canceled. Payload: GuestEventCanceledEnvelope - name: data | type: GuestEventCanceled | description: none - name: guest | type: EventGuest | description: Event guest. - name: _id | type: string | description: Guest GUID. - name: eventId | type: string | description: Event GUID. - name: rsvpId | type: string | description: RSVP GUID.

**Note:** Only applicable when `guestType` is `"RSVP"`. - name: orderNumber | type: string | description: Order number.

**Note:** Only applicable when `guestType` is `"BUYER"` or `"TICKET_HOLDER"`. - name: ticketNumber | type: string | description: Ticket number.

**Note:** Only applicable when `guestType` is `"TICKET_HOLDER"`. - name: tickets | type: array | description: List of names, numbers, and definition GUIDs for each ticket. - name: number | type: string | description: Ticket number. - name: definitionId | type: string | description: Ticket definition GUID. - name: name | type: string | description: Ticket name. - name: contactId | type: string | description: Guest's contact GUID. See the Contacts API for more details. - name: guestDetails | type: GuestDetails | description: Guest details.

Returned only when the `guestDetails` fieldset is sent in the request. - name: email | type: string | description: Email. - name: firstName | type: string | description: First name. - name: lastName | type: string | description: Last name. - name: formResponse | type: FormResponse | description: Form response. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: checkedIn | type: boolean | description: Whether the guest has checked into the event. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: The login details for the guest to access the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: phone | type: string | description: Phone extracted from form response. If multiples phone inputs are present, first one is returned. - name: address | type: string | description: Address extracted from form response. If multiples address inputs are present, first one is returned. - name: attendanceStatus | type: AttendanceStatus | description: Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information, see [Guest Attendance Status Mapping](https://dev.wix.com/docs/api-reference/business-solutions/events/registration/event-guests/guest-attendance-status-mapping.md).

**Note:** For `guestType` of `"BUYER"` or `"TICKET_HOLDER"` the `"IN_WAITLIST"` value is not applicable. - enum: - NOT_ATTENDING: Not attending. - ATTENDING: Attending. - IN_WAITLIST: In a waiting list. - name: secondaryLanguageCode | type: string | description: Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. - name: _createdDate | type: Date | description: Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. - name: _updatedDate | type: Date | description: Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. - name: attendanceStatusUpdatedDate | type: Date | description: Date and time of guest's latest attendance status update. - name: memberId | type: string | description: Site member GUID. - name: guestType | type: GuestType | description: Guest type. - enum: - RSVP: An invited guest, no ticket necessary. - BUYER: The guest who bought the ticket. - TICKET_HOLDER: The guest for whom the ticket was bought. - name: locale | type: string | description: Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale. - name: totalGuests | type: integer | description: Number of total guests in an event (registered guests + additional ones). - name: revision | type: string | description: Revision number, which increments by 1 each time the guest is updated. - name: additionalDetails | type: AdditionalDetails | description: Additional Details - name: _createdDate | type: Date | description: Date and time the source entity (RSVP or Order) was created. - name: _updatedDate | type: Date | description: Date and time the source entity (RSVP or Order) was updated. - name: rsvpStatus | type: RsvpStatus | description: Rsvp Status - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: orderStatus | type: OrderStatus | description: Order Status - enum: - UNKNOW_ORDER_STATUS: Order status is not available for this request fieldset. - FREE: Order is confirmed, no payment is required. - PENDING: Order was paid, but the payment gateway suspended the payment. - PAID: Order is paid. - OFFLINE_PENDING: Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. - INITIATED: Order is awaiting for payment at the cashier. - CANCELED: Order is canceled. - DECLINED: Order payment is declined. - AUTHORIZED: Order payment is authorized. - VOIDED: Order payment is voided. - PARTIALLY_PAID: Order is partially paid with less than the total amount. - name: event | type: EventDetails | description: Event context. - name: title | type: string | description: Event title. - name: shortDescription | type: string | description: Event short description. - name: location | type: Location | description: Event location. - name: name | type: string | description: Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. - name: type | type: LocationType | description: Location type. - enum: - VENUE: Event is on-site at a specific physical location. - ONLINE: Event is online, such as a virtual video conference. - name: address | type: Address | description: Exact location address. - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: addressLine1 | type: string | description: none - name: addressLine2 | type: string | description: none - name: locationTbd | type: boolean | description: Whether the event location is TBD. - name: dateAndTimeSettings | type: DateAndTimeSettings | description: Event date and time settings. - name: dateAndTimeTbd | type: boolean | description: Whether the event date and time are TBD. - name: dateAndTimeTbdMessage | type: string | description: Message that is displayed when time and date is TBD. **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`. - name: startDate | type: Date | description: Event start date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: endDate | type: Date | description: Event end date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: timeZoneId | type: string | description: Event time zone GUID in the [TZ database](https://www.iana.org/time-zones) format. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: hideEndDate | type: boolean | description: Whether the end date is hidden in the formatted date and time. - name: showTimeZone | type: boolean | description: Whether the time zone is displayed in the formatted schedule. - name: recurrenceStatus | type: Status | description: Repeating event status. - enum: - ONE_TIME: Event happens only once and can last multiple days. - RECURRING: A series of events that repeat. - RECURRING_UPCOMING: Next event in a schedule of recurring events. - RECURRING_RECENTLY_ENDED: Latest event that ended in a schedule of recurring events. - RECURRING_RECENTLY_CANCELED: Latest canceled event in a schedule of recurring events - name: recurringEvents | type: Recurrences | description: Event repetitions. - name: individualEventDates | type: array | description: Individual event dates for recurring events. *Note:** Each date must be manually calculated and provided. There is no support for automatic generation using recurrence rules or patterns (for example, "Weekly"). When you create a recurring event: - Each occurrence is created as an independent event with its own unique GUID. - All occurrences in the series share the same `categoryId`, which allows you to identify all events in the recurring series. - To retrieve all events in a recurring series, query events by `recurringEvents.categoryId`. - Each event in the series can be independently updated or deleted using its individual event GUID. - name: startDate | type: Date | description: Event start date. - name: endDate | type: Date | description: Event end date. - name: timeZoneId | type: string | description: Event time zone GUID in the [TZ database](https://www.iana.org/time-zones) format. - name: showTimeZone | type: boolean | description: Whether the time zone is displayed in a formatted schedule. - name: categoryId | type: string | description: Recurring event category GUID. This read-only field is automatically generated and shared by all events in a recurring series. Use this GUID to query and retrieve all occurrences of a recurring event. - name: formatted | type: Formatted | description: Formatted date and time settings. - name: dateAndTime | type: string | description: Formatted date and time representation.
Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`. - name: startDate | type: string | description: Formatted start date of the event. Empty for TBD schedules. - name: startTime | type: string | description: Formatted start time of the event. Empty for TBD schedules. - name: endDate | type: string | description: Formatted end date of the event. Empty for TBD schedules or when the end date is hidden. - name: endTime | type: string | description: Formatted end time of the event. Empty for TBD schedules or when the end date is hidden. - name: eventPageUrl | type: string | description: Event page URL components. - name: status | type: Status | description: Event status. - enum: - UPCOMING: Event is published and scheduled to start. - STARTED: Event has started. - ENDED: Event has ended. - CANCELED: Event is canceled. - DRAFT: Event is not public. - name: metadata | type: EventMetadata | description: none - name: instanceId | type: string | description: App instance GUID. - name: eventType | type: string | description: Event type. - name: identity | type: IdentificationData | description: The identification type and identity data. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). - name: appId | type: string | description: GUID of an app. - name: identityType | type: WebhookIdentityType | description: - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP - name: accountInfo | type: AccountInfo | description: Details related to the account - name: accountId | type: string | description: GUID of the Wix account associated with the event. - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account. - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site. - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them. - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. - name: entityId | type: string | description: GUID of the entity associated with the event. - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. ``` ### Examples ```javascript import { guests } from '@wix/events'; guests.onGuestEventCanceled((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { guests } from '@wix/events'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { guests, }, }); wixClient.guests.onGuestEventCanceled((event) => { // handle your event here }); ``` ---