Setup

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

Copy Code
npm install @wix/events

or

Copy Code
yarn add @wix/events

Then import { wixEvents } from @wix/events:

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

Setup

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

Copy Code
npm install @wix/events

or

Copy Code
yarn add @wix/events

Then import { wixEvents } from @wix/events:

Copy Code
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

bulkCancelEvents( )

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 events by filter. 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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
filterRecord<string, any>Required
Response Object
void
Was this helpful?
Yes
No

bulkDeleteEvents( )

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

Deletes events by filter. 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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
filterRecord<string, any>Required
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 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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
_idstringRequired
Event ID.
Response Object
CancelEventResponse
Was this helpful?
Yes
No

copy( )

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

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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
eventIdstringRequired
Event ID.

optionsCopyOptions
Response Object
CopyEventResponse
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.

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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
_idstringRequired
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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
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 or URL slug.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
optionsGetEventOptions
Response Object
GetEventResponse
Was this helpful?
Yes
No

listCategoryEvents( )

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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
categoryIdstringRequired
Category ID

optionsListCategoryEventsOptions
Response Object
ListCategoryEventsResponse
Was this helpful?
Yes
No

listEvents( )

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, filtering & sorting.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
optionsListEventsOptions
Response Object
ListEventsResponse
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 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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
_idstringRequired
Event ID.
Response Object
PublishDraftEventResponse
Was this helpful?
Yes
No

queryEventsV2( )

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 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
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
optionsQueryEventsV2Options
Response Object
QueryEventsV2Response
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's parameters. See Partial Updates for more information.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Params
_idstringRequired
Event ID.

optionsUpdateEventOptions
Response Object
UpdateEventResponse
Was this helpful?
Yes
No