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.
It’s important to note the following points before starting to code:
- Install the Wix Events & Tickets app from .
- Guest details are returned only when the
guestDetailsfieldset is sent in the request.
- In some situations, certain webhooks might be triggered twice. For example, changing a guest's name triggers the 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.
- 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.
The following table shows field support for filters and sorting for the Event Guest object:
|Field||Query Filter Operators||Sortable|
Related content: ,
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 ) 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:
eventId. by past
Retrieve all the email addresses from the
guestDetailsobject, 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:
eventId. of each past event, filtering by
For each event and each of its guests, retrieve the
guestDetails.checkedInvalue, and ensure that your code is capable of passing it to your analytics tool.
In your analytics tool, calculate for each event how many
falseand compute the attendance ratio.
Note: Only applicable when guestType is RSVP.
Note: Only applicable when guestType is BUYER or TICKET_HOLDER.
Note: Only applicable when guestType is TICKET_HOLDER.
Returned only when the guestDetails fieldset is sent in the request.
Note: For guestType BUYER or TICKET_HOLDER the IN_WAITLIST value is not applicable.
RSVP: An invited guest, no ticket necessary.
BUYER: The guest who bought the tickets.
TICKET_HOLDER: The guest for whom the ticket was bought.
Retrieves a list of guests given the provided paging, filtering, and sorting. Query Event Guests runs with these defaults, which you can override:
createdDateis sorted in
0For field support for filters and sorting, see . To learn about working with Query endpoints, see , , and .
Triggered when a guest is created.
Triggered when a guest is deleted.