> 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: rsvpV2 # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/rsvp-v2/rsvp-updated.md ## Introduction Triggered when an RSVP is updated. --- ## REST API ### Schema ``` Webhook: Rsvp Updated Description: Triggered when an RSVP is updated. 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: updatedEvent | type: object | description: Updated event details. - name: currentEntity | type: Rsvp | description: The entity after the update. - name: id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: createdDate | type: string | description: Date and time the RSVP was created. - name: updatedDate | type: string | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - 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: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: string | description: Date and time the guest checked in. - name: checkInCanceledDate | type: string | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing 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: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: modifiedFields | type: Map | description: Fields that were updated and their values before the update. ``` ### Examples ```curl { "id": "2e82070f-56be-400f-ad51-f1b7a3a6900f", "entityFqdn": "wix.events.rsvps.v2.rsvp", "slug": "updated", "entityId": "8c30fd39-c927-49c5-95d4-dc75c991681d", "updatedEvent": { "currentEntityAsJson": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "3", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T13:04:01.957Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [] }, { "inputName": "lastName", "value": "Doe", "values": [] }, { "inputName": "email", "value": "johndoe@mail.com", "values": [] } ] }, "status": "YES", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn":false }, "guestId": 1 } ], "anonymized": false, "fullyCheckedIn": false } }, "eventTime": "2023-10-20T13:04:01.972754Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "3" } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onRsvpUpdated Description: Triggered when an RSVP is updated. Payload: RsvpUpdatedEnvelope - name: entity | type: Rsvp | description: none - name: _id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: _createdDate | type: Date | description: Date and time the RSVP was created. - name: _updatedDate | type: Date | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - 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: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: Date | description: Date and time the guest checked in. - name: checkInCanceledDate | type: Date | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing 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: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: modifiedFields | type: Map | description: Fields that were updated and their values before the update. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - 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 { rsvpV2 } from '@wix/events'; rsvpV2.onRsvpUpdated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { rsvpV2 } from '@wix/events'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { rsvpV2, }, }); wixClient.rsvpV2.onRsvpUpdated((event) => { // handle your event here }); ``` ---