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:
It’s important to note the following points before starting to code:
guestDetails
fieldset is sent in the request.The event's guest attendance status updates based on the values of:
This table below maps out how the attendanceStatus
field is set based on the status
field by guest type:
Guest type | Status | Attendance Status |
---|---|---|
RSVP | YES | ATTENDING |
RSVP | WAITING | IN_WAITLIST |
RSVP | NO | NOT_ATTENDING |
BUYER | PAID | ATTENDING |
BUYER | OFFLINE_PENDING | ATTENDING |
BUYER | FREE | ATTENDING |
BUYER | PENDING | NOT_ATTENDING |
TICKET_HOLDER | PAID | ATTENDING |
TICKET_HOLDER | OFFLINE_PENDING | ATTENDING |
TICKET_HOLDER | FREE | ATTENDING |
TICKET_HOLDER | PENDING | NOT_ATTENDING |
The following table shows field support for filters and sorting for the Event Guest object:
Field | Query Filter Operators | Sortable |
---|---|---|
createdDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
updatedDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
attendanceStatusUpdatedDate | $eq , $ne , $lt , $lte , $gt , $gte , $in , $nin , $exists | Sortable |
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
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.
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:
Query Event Guests by past eventId
.
Retrieve all the email addresses from the guestDetails
object, and write your code so that they can be passed to your marketing tool.
Request and filter the list of subscribers in your external marketing tool by the retrieved emails.
Filter the list once again by the subscription status.
The contacts who have opted-in to marketing emails is now ready to receive the invitations.
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:
Query Event Guests of each past event, filtering by eventId
.
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.
In your analytics tool, calculate for each event how many guestDetails.checkedIn
values are false
and compute the attendance ratio.
Gives the information about all guests who bought tickets to an event or who RSVP'ed. Read more about Event Guests in this overview.
Guest ID.
Event ID.
RSVP ID.
Note: Only applicable when guestType
is RSVP
.
Order number.
Note: Only applicable when guestType
is BUYER
or TICKET_HOLDER
.
Ticket number.
Note: Only applicable when guestType
is TICKET_HOLDER
.
List of names, numbers, and definition IDs for each ticket.
Guest's contact ID. See Contacts API for more details.
Guest details.
Returned only when the guestDetails
fieldset is sent in the request.
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.
Secondary language code in ISO 639-1 format. Used when the event ticket should be translated into another language.
Date and time the guest was created in yyyy-mm-ddThh:mm:sssZ
format.
Date and time the guest was updated in yyyy-mm-ddThh:mm:sssZ
format.
Date and time of guest's latest attendance status update.
Site member ID.
Guest type.
Locale in IETF BCP 47 format. Used when the event date and time on a ticket should be formatted into another locale.
Number of total guests in an event (registered guests + additional ones).
Revision number, which increments by 1 each time the guest is updated.
{
"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
}
]
}
Retrieves a list of guests given the provided paging, filtering, and sorting. Query Event Guests runs with these defaults, which you can override:
createdDate
is sorted in ASC
orderpaging.limit
is 100
paging.offset
is 0
For field support for filters and sorting, see Event Guests: Supported Filters and Sorting.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.You can only call this method when authenticated as a Wix app or Wix user identity.
Query options. See API Query Language for more details.
Predefined sets of fields to return.
List of guests.
Metadata for the paginated results.
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"
}
}
}'
{
"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": {}
}
}
Triggered when a guest is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"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
}
}
}
Triggered when a guest is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"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
}
}
}
Triggered when a guest has checked in.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest
.
Event name. Expected guest_checked_in
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"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
}
}
}
{
"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
}
Triggered when an event is canceled.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest
.
Event name. Expected guest_event_canceled
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"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
}
}
}
{
"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
}
Triggered when an event has started.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest
.
Event name. Expected guest_event_starts
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"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
}
}
}
{
"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
}
Triggered when a ticket order is canceled.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest
.
Event name. Expected guest_order_canceled
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"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
}
}
}
{
"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
}
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.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.guests.v1.guest
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"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
}
}
}