Setup

To use the WixEvents API, install the @wix/events package using npm or Yarn:

Copy
1
npm install @wix/events

or

Copy
1
yarn add @wix/events

Then import { wixEvents } from @wix/events:

Copy
1
import { wixEvents } from '@wix/events'
Was this helpful?
Yes
No

Introduction

Wix events are gatherings that an individual or a business holds for a group of people. We refer to these people either as guests, participants, or attendees.

The Wix Events API provides functionality allowing you to:

  • Get and query Wix event information.
  • Create and update a Wix event.
  • Copy a Wix event.
  • Cancel and delete Wix events.
Was this helpful?
Yes
No

bulkCancelEventsByFilter( )

Developer Preview

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

Cancels multiple events that meet the given criteria.

After cancellation, registration for an event is closed. To reuse the event, clone and publish it again.

If event cancellation notifications are enabled, canceling an event automatically triggers the sending of 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.
Params
optionsBulkCancelEventsByFilterOptions
Response Object
void
Was this helpful?
Yes
No

bulkDeleteEventsByFilter( )

Developer Preview

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

Permanently deletes multiple events that meet the given criteria.

You can retrieve the deleted events through a 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.
Params
optionsBulkDeleteEventsByFilterOptions
Response Object
void
Was this helpful?
Yes
No

cancelEvent( )

Developer Preview

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

Cancels an event.

After cancellation, registration for an event is closed. To reuse the event, copy and publish it again.

If event cancellation notifications are enabled, canceling an event automatically triggers the sending of 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.
Params
eventIdstringRequired
Event ID.

optionsCancelEventOptions
Response Object
CancelEventResponse
Was this helpful?
Yes
No

cloneEvent( )

Developer Preview

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

Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.

The new event's date is automatically set to 14 days from the original event date.

If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)".

You can change the required entity field values while cloning an event. 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.
Params
eventIdstringRequired
Event ID.

optionsCloneEventOptions
Response Object
CloneEventResponse
Was this helpful?
Yes
No

countEventsByStatus( )

Developer Preview

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

Counts events by status. To learn about working with query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

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.
Params
optionsCountEventsByStatusOptions
Response Object
CountEventsByStatusResponse
Was this helpful?
Yes
No

createEvent( )

Developer Preview

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

Creates an event.

The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See Registration Form for more information.

You can create the event as a draft by setting the draft value to true. Otherwise, the event is published right away.

The event is automatically set up to send daily summary reports of new guests to your business email.

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.
Params
eventEventRequired
Event data.

optionsCreateEventOptions
Response Object
Event
Was this helpful?
Yes
No

deleteEvent( )

Developer Preview

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

Permanently deletes an event.

You can retrieve the deleted event through a 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.
Params
eventIdstringRequired
Event ID.
Response Object
DeleteEventResponse
Was this helpful?
Yes
No

findEvent( )

Developer Preview

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

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.

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.
Params
optionsFindEventOptions
Response Object
FindEventResponse
Was this helpful?
Yes
No

getEvent( )

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 an event by ID.

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.
Params
eventIdstringRequired
Event ID.

optionsGetEventOptions
Response Object
Event
Was this helpful?
Yes
No

getEventBySlug( )

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 an event by the slug URL.

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.
Params
slugstringRequired
URL slug.

optionsGetEventBySlugOptions
Response Object
GetEventBySlugResponse
Was this helpful?
Yes
No

publishDraftEvent( )

Developer Preview

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

Publishes a draft event to your live site. Once published, the event's status changes from DRAFT to UPCOMING.

It's impossible to revert the DRAFT status after publishing. The only option is to clone the event, then delete the original one.

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.
Params
eventIdstringRequired
Event ID.

optionsPublishDraftEventOptions
Response Object
PublishDraftEventResponse
Was this helpful?
Yes
No

queryEvents( )

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 events, given the provided paging, filtering, and sorting. Query Events runs with these defaults, which you can override:

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in(),ascending(),descending()
dateAndTimeSettings.startDateeq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
dateAndTimeSettings.endDateeq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
titleeq(),ne(),in(),ascending(),descending()
slugeq(),ne(),in(),ascending(),descending()
_createdDateeq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
_updatedDateeq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
statuseq(),ne(),in()
registration.initialTypeeq()
userIdeq(),ne(),in()

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.
Params
optionsQueryEventsOptions
Response Object
EventsQueryBuilder
Was this helpful?
Yes
No

updateEvent( )

Developer Preview

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

Updates an event.

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.
Params
_idstringRequired
Event ID.

optionsUpdateEventOptions
Response Object
Event
Was this helpful?
Yes
No