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 [] [Optional]
      ├─ accountId (string)
      └─ ari (string)
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy [] [Required]
      ├─accountId (string)
      └─ ari
  └─ permissions 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:calendar-event
  ├─ eventStartTime (string) [Required]
  ├─ eventEndTime (string) [Required]
  ├─ attendees (List<Attendee>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      ├─ externalId (string) [Optional]
      ├─ ari (string) [Optional]
      ├─ name (string) [Optional]
      ├─ userName (string) [Optional]
      ├─ avatar (string) [Optional]
      └─ url (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

Calendar event properties

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" : [ {
      "action" : "read",
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "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
      } ]
    }
  } ],
  "operationType" : "NORMAL"
}