Introduction

With the Schedule API you can share the lineup of an event’s activities, presentations, performances, or sessions. Guests can make a personalized agenda with their chosen items by bookmarking them. The created schedule will appear on your Event Details page.

With the Schedule API you can:

  • Add, delete, update schedule items.
  • Adjust time of all draft schedule items at once.
  • Publish or discard draft schedule.
  • Get the information about schedules.

Terminology

  • Schedule: A structured plan or timetable that outlines the sequence of activities, presentations, performances, or sessions scheduled to occur during an event.
  • Schedule item: A specific activity, presentation, performance, or session listed within the overall schedule of an event. Each schedule item represents a distinct component of the event's agenda and may include details such as the activity name, time slot, location, and any additional information relevant to the event's program.
  • Event: A gathering organized by an individual or business for a group of people.
Did this help?

Setup

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

Copy

or

Copy

Then import { schedule } from @wix/events:

Copy
Did this help?

addScheduleItem( )

Adds a schedule item to the draft schedule.

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 Events - all permissions
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function addScheduleItem(
  eventId: string,
  options: AddScheduleItemOptions,
): Promise<AddScheduleItemResponse>;
Method Parameters
eventIdstringRequired

Event ID to which the schedule belongs.

optionsAddScheduleItemOptions

Optional fields.

Returns
Return Type:Promise<AddScheduleItemResponse>
JavaScript
import { schedule } from "@wix/events";

async function addScheduleItem(eventId, options) {
  const response = await schedule.addScheduleItem(eventId, options);
}
Errors

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

Did this help?