About Event Guests

The Event Guests API allows you to retrieve information about all guests who bought tickets to an event or who RSVP'ed. This can be particularly useful for event organizers who need to manage large numbers of attendees or who want to integrate their event management system with other software tools. Additionally, with the Event Guests API you can create custom applications that leverage event guest data, such as mobile event apps or marketing automation systems.

The Event Guests API allows you to:

  • Retrieve a list of guests by event ID.
  • Get information about each individual ticket buyer.
  • Find out the attendance status of each guest.

Before you begin

It’s important to note the following points before starting to code:

  • Install the Wix Events & Tickets app from Wix App Market.
  • Guest details are returned only when the guestDetails fieldset is sent in the request.
  • In some situations, certain webhooks might be triggered twice. For example, changing a guest's name triggers the Event Guest Updated webhook 2 times -- once for the change of name and once for the change of order, which also occured. While technically correct behavior, this might cause the undesired side effect of duplicated actions. Make sure to explicitly add code to make sure parts of your code only run once.

Use cases

Terminology

  • Guest: The individual who has been invited to the event.
  • RSVP: A response from the guest indicating whether they plan to attend the event.
  • Ticket buyer: The individual who bought 1 or more tickets to the event.
  • Check-in: The process of verifying a guest's attendance at the event.
  • Guest list: A summary of all guests who have been invited to the event.
  • Organizer: The person or entity responsible for planning and hosting the event.
Did this help?

Event Guests: Guest Attendance Status Mapping

The event's guest attendance status updates based on the values of:

  • For RSVP events: The status of a guest as defined in the RSVP object.
  • For ticketed events: The status of a buyer or ticket holder as defined in the Order object.

This table below maps out how the attendanceStatus field is set based on the status field by guest type:

Guest typeStatusAttendance Status
RSVPYESATTENDING
RSVPWAITINGIN_WAITLIST
RSVPNONOT_ATTENDING
BUYERPAIDATTENDING
BUYEROFFLINE_PENDINGATTENDING
BUYERFREEATTENDING
BUYERPENDINGNOT_ATTENDING
TICKET_HOLDERPAIDATTENDING
TICKET_HOLDEROFFLINE_PENDINGATTENDING
TICKET_HOLDERFREEATTENDING
TICKET_HOLDERPENDINGNOT_ATTENDING
Did this help?

Event Guests: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Event Guest object:

FieldQuery Filter OperatorsSortable
createdDate$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $existsSortable
updatedDate$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $existsSortable
attendanceStatusUpdatedDate$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $existsSortable
id$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
eventId$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
rsvpId$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
memberId$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
contactId$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
attendanceStatus$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
ticketNumber$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
orderNumber$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
attendanceStatus$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
guestType$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
guestDetails.checkedIn$eq, $ne, $exists
secondaryLanguageCode$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, $exists
tickets$exists

Related content: API Query Language, Event Guest Query endpoint

Did this help?

Event Guests: Sample Use Cases & Flows

This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.

Send invitations to customers for a new event

A lot of users aim to re-engage attendees who have previously participated in similar events or activities. With your app, you can retrieve the guest list from a past event and create a targeted email campaign that includes details about the upcoming event. The invitation can be tailored based on the past attendance history (see Get guest attendance analytics from your analytics system or preferences of guests. This use case can be an effective way to increase attendance at future events, and generate more interest in them.

Note: This flow assumes your guests already have the ability to subscribe to your newsletters.

To send invitations about an upcoming event, follow these steps:

  1. Query Event Guests by past eventId.

  2. Retrieve all the email addresses from the guestDetails object, and write your code so that they can be passed to your marketing tool.

  3. Request and filter the list of subscribers in your external marketing tool by the retrieved emails.

  4. Filter the list once again by the subscription status.

  5. The contacts who have opted-in to marketing emails is now ready to receive the invitations.

Get guest attendance analytics from your analytics system

An analytics system can provide valuable insights into guest attendance at events, making it easier to track and analyze data on attendance patterns, behavior, and preferences. For example, you can use your app to periodically check attendance for your events to determine which events often have no-shows. This information could help you determine if certain events need more advertising, reminders, or a change to pricing (for example, people are more likely to attend if they have paid, even a small amount, to attend).

To get attendance analytics, follow these steps:

  1. Query Event Guests of each past event, filtering by eventId.

  2. For each event and each of its guests, retrieve the guestDetails.checkedIn value, and ensure that your code is capable of passing it to your analytics tool.

  3. In your analytics tool, calculate for each event how many guestDetails.checkedIn values are false and compute the attendance ratio.

Did this help?

Guest Object


Gives the information about all guests who bought tickets to an event or who RSVP'ed. Read more about Event Guests in this overview.

Properties
idstringformat GUID

Guest ID.


eventIdstringformat GUID

Event ID.


rsvpIdstringformat GUID

RSVP ID.

Note: Only applicable when guestType is RSVP.


orderNumberstringmaxLength 36

Order number.

Note: Only applicable when guestType is BUYER or TICKET_HOLDER.


ticketNumberstringmaxLength 36

Ticket number.

Note: Only applicable when guestType is TICKET_HOLDER.


ticketsArray <TicketDetails>maxItems 50

List of names, numbers, and definition IDs for each ticket.


contactIdstringformat GUID

Guest's contact ID. See Contacts API for more details.


guestDetailsGuestDetails

Guest details.

Returned only when the guestDetails fieldset is sent in the request.


attendanceStatusstring

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 read this article.

Note: For guestType BUYER or TICKET_HOLDER the IN_WAITLIST value is not applicable.


secondaryLanguageCodestringformat LANGUAGE

Secondary language code in ISO 639-1 format. Used when the event ticket should be translated into another language.


createdDatestringformat date-time

Date and time the guest was created in yyyy-mm-ddThh:mm:sssZ format.


updatedDatestringformat date-time

Date and time the guest was updated in yyyy-mm-ddThh:mm:sssZ format.


attendanceStatusUpdatedDatestringformat date-time

Date and time of guest's latest attendance status update.


memberIdstringformat GUID

Site member ID.


guestTypestring

Guest type.


localestringformat LANGUAGE_TAG

Locale in IETF BCP 47 format. Used when the event date and time on a ticket should be formatted into another locale.


totalGuestsintegerRead-onlyformat int32

Number of total guests in an event (registered guests + additional ones).


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the guest is updated.

EventGuest
JSON
{ "guests": [ { "id": "ab249e78-edb0-4857-8b4b-d42b672ee764", "eventId": "b189cf8b-a61f-443b-95bb-d9e88af0a277", "rsvpId": "431321d0-f768-45c8-a390-9827c0107e0f", "tickets": [], "guestDetails": { "email": "patsy.mcbride@mail.com", "firstName": "Patsy", "lastName": "McBride", "formResponse": { "inputValues": [ { "inputName": "firstName", "value": "Patsy", "values": [] }, { "inputName": "lastName", "value": "McBride", "values": [] }, { "inputName": "email", "value": "patsy.mcbride@mail.com", "values": [] } ] }, "checkedIn": false }, "contactId": "023b6403-17e6-42dc-b475-a5ae6c2b8df4", "attendanceStatus": "IN_WAITLIST", "createdDate": "2023-01-10T13:22:23.302Z", "updatedDate": "2023-01-10T13:22:23.302Z", "attendanceStatusUpdatedDate": "2023-01-10T13:22:23Z", "guestType": "RSVP", "totalGuests": 1, "revision": 1 } ] }
Did this help?

POST

Query Event Guests


Retrieves a list of guests given the provided paging, filtering, and sorting. Query Event Guests runs with these defaults, which you can override:

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events-guests/v2/guests/query

Body Params
queryQueryRequired

Query options. See API Query Language for more details.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
guestsArray <EventGuest>

List of guests.


pagingMetadataPagingMetadata

Metadata for the paginated results.

Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/guests/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ --data-binary '{ "query": { "filter": { "guestType": "RSVP" } } }'
Response
JSON
{ "guests": [ { "id": "ab249e78-edb0-4857-8b4b-d42b672ee764", "eventId": "b189cf8b-a61f-443b-95bb-d9e88af0a277", "rsvpId": "431321d0-f768-45c8-a390-9827c0107e0f", "tickets": [], "contactId": "023b6403-17e6-42dc-b475-a5ae6c2b8df4", "attendanceStatus": "IN_WAITLIST", "createdDate": "2023-01-10T13:22:23.302Z", "updatedDate": "2023-01-10T13:22:23.302Z", "attendanceStatusUpdatedDate": "2023-01-10T13:22:23Z", "guestType": "RSVP" } ], "pagingMetadata": { "count": 1, "cursors": {} } }
Did this help?

Event Guest Created


Triggered when a guest is created.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.guests.v1.guest_created", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }
Did this help?

Event Guest Deleted


Triggered when a guest is deleted.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.guests.v1.guest_deleted", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }
Did this help?

Guest Checked In


Triggered when a guest has checked in.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest.


slugstring

Event name. Expected guest_checked_in.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.guests.v1.guest_guest_checked_in", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

GuestCheckedIn
JSON
{ "id": "29f9df0b-d462-4820-803b-0fbd3db65445", "entityFqdn": "wix.events.guests.v1.guest", "slug": "guest_checked_in", "entityId": "13127c35-dea6-422f-a9a4-bb48ccbb3619", "actionEvent": { "bodyAsJson": { "guest": { "id": "13127c35-dea6-422f-a9a4-bb48ccbb3619", "eventId": "45d6d825-f464-4120-8a6c-9306a50095de", "orderNumber": "2WCH-J81D-5R0", "ticketNumber": "2WCH-J81D-5R02J", "tickets": [ { "number": "2WCH-J81D-5R02J", "definitionId": "83e20115-4feb-4c1f-b11f-4bbe14c03a33", "name": "Early Bird", "guestDetails": {} } ], "contactId": "5ea73bf5-d323-4784-a78e-556d1c9f1fff", "guestDetails": { "checkedIn": true }, "attendanceStatus": "ATTENDING", "createdDate": "2025-01-02T12:46:38.238Z", "updatedDate": "2025-01-02T12:46:38.238Z", "attendanceStatusUpdatedDate": "2025-01-02T12:46:38.238Z", "memberId": "5ea73bf0-d323-4784-a78e-556d1c951fff", "guestType": "TICKET_HOLDER", "totalGuests": 1 }, "eventDetails": { "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" } }, "status": "STARTED" } } }, "eventTime": "2025-01-02T12:46:39.127534849Z", "triggeredByAnonymizeRequest": false }
Did this help?

Guest Event Canceled


Triggered when an event is canceled.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest.


slugstring

Event name. Expected guest_event_canceled.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.guests.v1.guest_guest_event_canceled", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

GuestEventCanceled
JSON
{ "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 }
Did this help?

Guest Event Starts


Triggered when an event has started.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest.


slugstring

Event name. Expected guest_event_starts.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.guests.v1.guest_guest_event_starts", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

GuestEventStarts
JSON
{ "id": "4e189b6f-56ac-4332-a68a-b4961c67a209", "entityFqdn": "wix.events.guests.v1.guest", "slug": "guest_event_starts", "entityId": "501554db-e150-404b-95ae-94ef636f4a7f", "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" }, "timing": "STARTS_IN_1_WEEK" } }, "eventTime": "2025-01-02T11:49:40.235282055Z", "triggeredByAnonymizeRequest": false }
Did this help?

Guest Order Canceled


Triggered when a ticket order is canceled.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest.


slugstring

Event name. Expected guest_order_canceled.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.guests.v1.guest_guest_order_canceled", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

GuestOrderCanceled
JSON
{ "id": "4e189b6f-56ac-4332-a68a-b4961c67a209", "entityFqdn": "wix.events.guests.v1.guest", "slug": "guest_order_canceled", "entityId": "501554db-e150-404b-95ae-94ef636f4a7f", "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" }, "order": { "orderStatus": "CANCELED", "invoice": { "items": [ { "id": "8ecd9ba2-a5a3-4d22-0000-fed536806897", "quantity": 1, "name": "John Doe", "price": { "amount": "0.00", "currency": "EUR", "value": "0.00" }, "total": { "amount": "0.00", "currency": "EUR", "value": "0.00" }, "fees": [ { "type": "FEE_ADDED_AT_CHECKOUT", "rate": "2.5", "amount": { "amount": "0.00", "currency": "EUR", "value": "0.00" } } ] } ], "total": { "amount": "0.00", "currency": "EUR", "value": "0.00" }, "subTotal": { "amount": "0.00", "currency": "EUR", "value": "0.00" }, "grandTotal": { "amount": "0.00", "currency": "EUR", "value": "0.00" }, "fees": [ { "type": "FEE_ADDED_AT_CHECKOUT", "rate": "2.5", "amount": { "amount": "0.00", "currency": "EUR", "value": "0.00" } } ], "revenue": { "amount": "0.00", "currency": "EUR", "value": "0.00" } } } } }, "eventTime": "2025-01-02T11:49:40.235282055Z", "triggeredByAnonymizeRequest": false }
Did this help?

Event Guest Updated


Triggered when a guest is updated. This webhook always fires together with Event Guest Created and Event Guest Deleted webhooks. When calling it, it might be triggered twice - make sure to explicitly add code to make sure parts of your code only run once.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.guests.v1.guest_updated", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }
Did this help?