Calendar event

The Calendar event object type represents a calendar event object. atlassian:calendar-event should be used to ingest calendar event-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy (userReference) [Required]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Optional]
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:calendar-event
  ├─ eventStartTime (string) [Required]
  ├─ eventEndTime (string) [Required]
  ├─ attendees (List<Attendee>) [Optional]
      ├─ user (userReference) [Optional]
          ├─ accountId (string) [Optional]
          ├─ email (string) [Optional]
          ├─ externalId (string) [Required]
      ├─ isOptional (string) [Optional]
      ├─ rsvpStatus (string) [Optional]
  ├─ location (Location) [Optional]
      ├─ name (string) [Optional]
      ├─ address (string) [Optional]
      ├─ url (string) [Optional]
      └─ coordinates (string) [Optional]
  ├─ videoMeetingUrl (string) [Optional]
  ├─ recordingUrl (string) [Optional]
  ├─ isAllDayEvent (boolean) [Optional]
  ├─ attendeeCount (integer) [Optional]
  ├─ exceedsMaxAttendees (boolean) [Optional]
  ├─ videoMeetingProvider (string) [Optional]
  ├─ isRecurringEvent (boolean) [Optional]
  ├─ recurringEventId (string) [Optional]
  ├─ eventType (string) [Required]
  └─ attachments [] [Optional]
      ├─ name (string) [Required]
      ├─ url (string) [Required]
      └─ mimeType (string) [Optional]

Common properties

Property	Type	Required	Description
`schemaVersion`	`string`	Yes	The schema version of the object.
`id`	`string`	Yes	The ID of the object in the source system.
`updateSequenceNumber`	`long`	Yes	A sequence number to compare when writing to the database. Objects are written following a last write wins strategy, therefore an object with a greater `UpdateSequenceNumber` is considered a more recently updated object.
`displayName`	`string`	Yes	The display name of the object.
`description`	`string`	No	The description of the object.
`url`	`string`	Yes	The URL from the provider which the object is accessible from.
`createdAt`	`string`	Yes	The date the object was created. Format: Instant (ISO8601 / RFC3339)
`createdBy`	`userReference`	No	A reference to the user that created the object. See userReference to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`userReference`	No	A reference to the user that last updated the object. See userReference to learn more.
`owners`	`list<userReference>`	No	List of references of users that own the object.
`thumbnail`	`thumbnail`	No	The thumbnail of the object. See Thumbnail to learn more.
`parentKey`	`entityKey`	No	The ID of the parent object. If null, it is a standalone object. See Entity key to learn more.
`containerKey`	`entityKey`	No	The container identifier that this object belongs to. See Entity key to learn more.
`permissions`	`list<Permissions>`	Yes	The permissions configuration of the object. See Permissions to learn more.
`associations`	`association`	No	List of objects associated with the object. Generally used to link an external object to a Atlassian object. See Association to learn more.

Calendar event properties

Property	Type	Required	Description
`eventStartTime`	`string`	Yes	The start time of the calendar event. Format: Instant (ISO8601 / RFC3339)
`eventEndTime`	`string`	Yes	The end time of the calendar event. Format: Instant (ISO8601 / RFC3339)
`eventType`	`string`	Yes	The type of the calendar event. Allowed values: `default` `event` `focus_time` `out_of_office` `working_location` `task` `appointment` `reminder` `birthday`
`attendees`	`List<Attendee>`	No	List of attendees for the calendar event.
`attendees.user`	`userReference`	No	The userReference of the attendee.
`attendees.isOptional`	`boolean`	No	Indicates if the attendee is optional.
`attendees.rsvpStatus`	`string`	No	The RSVP status of the attendee. Allowed values: `accepted` `tentatively_accepted` `declined` `not_responded` `other`
`location`	`Location`	No	The location object for the calendar event.
`location.name`	`string`	No	The name of the location.
`location.address`	`string`	No	The address of the location.
`location.url`	`string`	No	The URL of the location.
`location.coordinates`	`string`	No	The coordinates of the location.
`videoMeetingUrl`	`string`	No	The URL for the video meeting associated with the calendar event.
`recordingUrl`	`string`	No	The URL for the recording of the calendar event.
`isAllDayEvent`	`boolean`	No	Indicates whether this is an all-day event.
`attendeeCount`	`integer`	No	The total number of attendees for the calendar event.
`exceedsMaxAttendees`	`boolean`	No	Indicates whether the event exceeds the maximum number of attendees.
`videoMeetingProvider`	`string`	No	The provider of the video meeting service. Allowed values: `google_meet` `ms_teams` `zoom` `other`
`isRecurringEvent`	`boolean`	No	Indicates whether this is a recurring event.
`recurringEventId`	`string`	No	The ID of the recurring event series.
`attachments`	`list<Attachment>`	No	List of attachments for the calendar event.
`attachments.name`	`string`	Yes	The name of the attachment.
`attachments.url`	`string`	Yes	The URL of the attachment.
`attachments.mimeType`	`string`	No	The MIME type of the attachment.

Example payload

1
2
{
  "objects" : [ {
    "id" : "calendar-event-1",
    "updateSequenceNumber" : 1,
    "description" : "Team meeting",
    "url" : "https://calendar.example.com/event/1",
    "displayName" : "Event Name",
    "createdAt" : "2024-04-16T09:31:32+00:00",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedAt" : "2024-04-16T09:31:32+00:00",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:calendar-event" : {
      "eventStartTime" : "2024-04-16T09:31:32+00:00",
      "eventEndTime" : "2024-04-16T09:31:32+00:00",
      "attendees" : [ {
        "user" : {
          "externalId" : "external-id-1"
        },
        "isOptional" : false,
        "rsvpStatus" : "accepted"
      }, {
        "user" : {
          "externalId" : "external-id-2"
        },
        "isOptional" : true,
        "rsvpStatus" : "tentatively_accepted"
      } ],
      "location" : {
        "name" : "location name",
        "address" : "location address",
        "url" : "https://calendar.example.com/location-url",
        "coordinates" : "coordinates"
      },
      "videoMeetingUrl" : "https://calendar.example.com/video-meeting-url",
      "recordingUrl" : "https://calendar.example.com/video-recording-url",
      "isAllDayEvent" : false,
      "attendeeCount" : 2,
      "exceedsMaxAttendees" : false,
      "videoMeetingProvider" : "other",
      "isRecurringEvent" : false,
      "recurringEventId" : "recurringEventId",
      "eventType" : "out_of_office",
      "attachments" : [ {
        "url" : "https://calendar.example.com/files/attachment1.png",
        "mimeType" : "image/png",
        "byteSize" : 140288
      } ]
    }
  } ]
}