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.

If you provide recurrenceRule, an event with {"recurrenceType": "MASTER"} is created. Then, you can't set start.localDate to a past date, though the time can be earlier on the same day. You can, however, create single-occurrence events for past dates.

You can't create an event with recurrenceType set to INSTANCE or EXCEPTION. INSTANCE events are generated automatically based on the recurrence rule in the relevant MASTER event. EXCEPTION events are automatically created when you update an INSTANCE event, which changes its recurrenceType to EXCEPTION.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage Bookings
Manage Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
eventEventRequired

Event to create.

optionsCreateEventOptions
Returns
Return Type:Promise<Event>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?