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

Event Object

Attributes
idstringRead-onlyformat GUID
Event ID.

locationobject
Event location.

schedulingobject
Event scheduling.

titlestring
Event title.

descriptionstring
Event description.

aboutstring
Rich-text content displayed in Wix UI - "About Event" section (HTML).

mainImageobject
Main event image.

slugstring
Event slug URL (generated from event title).

languagestring
ISO 639-1 language code of the event (used in content translations).

createdstringformat date-time
Event creation timestamp.

modifiedstringformat date-time
Event modified timestamp.

statusstring
5 supported values:
SCHEDULEDSTARTEDENDEDCANCELEDDRAFT
Event status.

registrationobject
RSVP or ticketing registration details.

calendarLinksobject
"Add to calendar" URLs.

eventPageUrlobject
Event page URL components.

formobject
Event registration form.

dashboardobject
Event dashboard summary of RSVP / ticket sales.

instanceIdstring
Instance ID of the site where event is hosted.

guestListConfigobject
Guest list configuration.

userIdstringformat GUID
Event creator user ID.

feedobject
Event discussion feed. For internal use.

onlineConferencingobject
Online conferencing details.

seoSettingsobject
SEO settings.

assignedContactsLabelstring
Assigned contacts label key.

agendaobject
Agenda details.

categoriesArray <Category>
Categories this event is assigned to.

eventDisplaySettingsobject
Visual settings for event.
Was this helpful?
Yes
No

PostQuery Events

Deprecated

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:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v1/events/query

Was this helpful?
Yes
No

PostQuery Events V 2

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-level fieldset 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 in DESC order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v2/events/query

Was this helpful?
Yes
No

GetList Events

Retrieves a list of up to 100 events, given the provided paging, filtering & sorting.

Note: This endpoint is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/events/v1/events

Was this helpful?
Yes
No

GetList Category Events

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/events/v1/events/category/{categoryId}

Was this helpful?
Yes
No

GetGet Event

Retrieves an event by ID or URL slug.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/events/v1/events/event

Was this helpful?
Yes
No

GetFind Event

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 is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/events/v1/events/event/find

Was this helpful?
Yes
No

PostCreate Event V 2

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:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v2/events

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCopy Event

Deprecated

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:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v1/events/{eventId}/copy

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCopy Event V 2

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:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v2/events/{id}/copy

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

DeleteDelete Event

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:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/events/v1/events/{id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PatchUpdate Event

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:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostPublish Draft Event

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 is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v1/events/{id}/publish

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCancel Event

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:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/events/v1/events/{id}/cancel

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostBulk Cancel Events

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 is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostBulk Delete Events

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 is relevant only for Headless projects.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Events
Learn more about permission scopes.
Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Event Started

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
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
timestampstringformat date-time
Event start timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.
Was this helpful?
Yes
No

Event Reminder

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
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
timestampstringformat date-time
Reminder timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.

locationobject
Event location.

scheduleConfigobject
Event schedule configuration.

titlestring
Event title.

userIdstringformat GUID
Event creator user ID.

startsInobject
Time until the event starts (currently, reminder is triggered 1 day before event starts).
Was this helpful?
Yes
No

Event Ended

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
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
timestampstringformat date-time
Event end timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.
Was this helpful?
Yes
No

Event Created

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
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
timestampstringformat date-time
Event created timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.

locationobject
Event location.

scheduleConfigobject
Event schedule configuration.

titlestring
Event title.

userIdstringformat GUID
Event creator user ID.

statusstring
5 supported values:
SCHEDULEDSTARTEDENDEDCANCELEDDRAFT
Event status.

derivedFromInstanceIdstringformat GUID
Instance ID. Indicates the original app instance which current event was derived from.

derivedFromEventIdstringformat GUID
Event ID. Indicates the original event which current event was derived from.
Was this helpful?
Yes
No

Event Updated

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
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
timestampstringformat date-time
Event update timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.

locationobject
Event location.

scheduleConfigobject
Event schedule configuration.

titlestring
Event title.

scheduleConfigUpdatedbooleandeprecated
Whether schedule configuration was updated.
Was this helpful?
Yes
No

Event Canceled

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
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
timestampstringformat date-time
Event canceled timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.

titlestring
Event title

userIdstringformat GUID
Event creator user ID.
Was this helpful?
Yes
No

Event Deleted

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events
Manage Guest List
Manage Events
Learn more about permission scopes.
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
timestampstringformat date-time
Event deleted timestamp in ISO UTC format.

eventIdstringformat GUID
Event ID.

titlestring
Event title.

userIdstringformat GUID
Event creator user ID.
Was this helpful?
Yes
No