# Basic Config

# title

  • Type: string
  • Required: no
  • Default: (Empty string)

The event title (i.e., summary). Line breaks are automatically stripped.

# description

  • Type: string
  • Required: no
  • Default: (Empty string)

The event description. Line breaks are automatically converted to \n.

# location

  • Type: string
  • Required: no
  • Default: (Empty string)

A summary description of the event location. Line breaks are automatically stripped.

# start

The event start timestamp.

# end

The event end timestamp. For all-day events, this field should be omitted.

# recurrence

The specification for when the event should repeat. See CalendarRecurrence for more information.

Note

This feature is not supported in Yahoo or Outlook online calendars.

# attendees 6.2.3

  • Type: CalendarAttendee[]
  • Required: no
  • Valid value: an array of valid CalendarAttendee objects

A list of attendees for the event. See CalendarAttendee for more information.