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.
Was this helpful?
Yes
No

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

Was this helpful?
Yes
No

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.

Was this helpful?
Yes
No

Guest Object

Attributes
idstringformat GUID
Guest ID.

eventIdstringformat GUID
Event ID.

rsvpIdstringformat GUID
RSVP ID.

Note: Only applicable when guestType is RSVP.

orderNumberstring
Order number.

Note: Only applicable when guestType is BUYER or TICKET_HOLDER.

ticketNumberstring
Ticket number.

Note: Only applicable when guestType is TICKET_HOLDER.

ticketsArray <TicketDetails>
List of names, numbers, and definition IDs for each ticket.

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

guestDetailsobject
Guest details.

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

attendanceStatusstring
3 supported values:
NOT_ATTENDINGATTENDINGIN_WAITLIST
Attendance status.

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
3 supported values:
RSVPBUYERTICKET_HOLDER
Guest type:

RSVP: An invited guest, no ticket necessary.

BUYER: The guest who bought the tickets.

TICKET_HOLDER: The guest for whom the ticket was bought.
Was this helpful?
Yes
No

PostQuery 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:

Endpoint
POST
https://www.wixapis.com/events-guests/v2/guests/query

Was this helpful?
Yes
No

Event Guest Created

Triggered when a guest is created.

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.

createdEventobject
Event information.
Was this helpful?
Yes
No

Event Guest Updated

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.

updatedEventobject
Event information.
Was this helpful?
Yes
No

Event Guest Deleted

Triggered when a guest is deleted.

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.
Was this helpful?
Yes
No