About the Events API
An event is a type of gathering an individual or a business holds for a group of people.
Wix Events support 3 different types of events:
- RSVP events: Free events that collect RSVPs - yes/no attendance tracking (e.g., a wedding).
- Ticketed events: Events which have tickets for sale (e.g., a conference).
- External registration events: Events where the registration occurs on a different website and the event within the Wix platform is display-only.
Each event can include the following properties:
- General info: event title, description, rich text about section.
- Scheduling information: start and end date times, time zone of the event etc.
- Location (including map coordinates).
- Registration form settings.
- Ticket definition settings (for Ticketed Events).
- External registration link (for External Registration Events).
This method has been replaced with QueryEventsV2, and will be removed on June 11, 2022.
Retrieves a list of up to 1,000 events, given the provided paging, filtering and sorting.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Query Events and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Retrieves a list of up to 1,000 events, given the provided paging, filtering and sorting.
** Important **:
- All results are for one specific business, resolved from the request context.
Query object support:
filter
- supported, see filtering and sorting.sort
- supported, see filtering and sorting.paging
- supported, see paging.fields
- not supported.fieldsets
- not supported, use request-levelfieldset
instead.cursorPaging
- not supported, use offset pagination instead.
Defaults:
- When filter is not specified, returns all events that caller is authorized to read.
- When sorting is not specified, defaults to
created
inDESC
order.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Query Events and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Retrieves a list of up to 100 events, given the provided paging, filtering & sorting.
Note: This endpoint requires visitor or member authentication.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deprecation Notice
This endpoint has been replaced with Events V3's Query Events and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Retrieves a list of up to 100 events, given the provided paging and category_id. Events are sorted by the sort index defined by CategoryManagement.
Note: This endpoint requires visitor or member authentication.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Get Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Retrieves an event by ID or URL slug.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Get Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Finds an event by ID or URL slug. In contrast to Get Event endpoint which returns not found error, Find Event returns empty response when an event is not found.
Note: This endpoint requires visitor or member authentication.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Create Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Creates a new event, with a default registration form in the given language. Default registration form includes first name, last name, and email inputs. To learn more about registration form and customize it, see Registration Form. The event is automatically configured to send daily summary reports of new registrations to site business email. RegistrationConfig.initialType is required - allowed value when creating is RSVP or TICKETS.
Permission Scopes
For app development, you must have one of the following permission scopes:This method has been replaced with CopyEventV2, and will be removed on June 11, 2022.
Copies an event, including its registration form, notifications and tickets configuration - scheduled two weeks from the original event. Multilingual translations are also copied to the new event.
When an event with same title already exists, appends (1), (2), ... to it. For example, copying an event titled "My Event" creates "My Event (1)". Very long event titles are cropped: "Daily stand-up ev... (2)".
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Clone Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Copies an event, including its registration form, notifications and tickets configuration - scheduled two weeks from the original event. Multilingual translations are also copied to the new event. Supports partial update of the original event fields. See Partial Updates for more information.
When an event with same title already exists, appends (1), (2), ... to it. For example, copying an event titled "My Event" creates "My Event (1)". Very long event titles are cropped: "Daily stand-up ev... (2)".
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Delete Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Deletes an event. Deleted events are not returned via API. The only way to retrieve them is via GDPR access request.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Update Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Updates an event's parameters. See Partial Updates for more information.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Update Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Publishes draft event so that it becomes available to site visitors. If recurring events are set, category with state RECURRING_EVENT will be created. All recurring events will be assigned to this category.
Note: This endpoint requires visitor or member authentication.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Cancel Event and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Cancels an event and closes registration. If event cancellation notifications are enabled, canceling an event automatically sends cancellation emails and/or push notifications to registered guests.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Bulk Cancel Events By Filter and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Cancels events by filter. If event cancellation notifications are enabled, canceling an event automatically sends cancellation emails and/or push notifications to registered guests.
Note: This endpoint requires visitor or member authentication.
Permission Scopes
For app development, you must have one of the following permission scopes:Deprecation Notice
This endpoint has been replaced with Events V3's Bulk Delete Events By Filter and will be removed on November 6, 2024. If your app uses this endpoint, we recommend updating your code as soon as possible.
Deletes events by filter. Deleted events are not returned via API. The only way to retrieve them is via GDPR access request.
Note: This endpoint requires visitor or member authentication.