Video

The Video object type represents a video entity like a Loom video. atlassian:video should be used to ingest video-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) [Optional]
      ├─ 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:video
  ├─ thumbnailUrl (string) [Required]
  ├─ embedUrl (string) [Required]
  ├─ durationInSeconds (integer) [Optional]
  ├─ width (integer) [Optional]
  ├─ height (integer) [Optional]
  ├─ commentCount (integer) [Optional]
  ├─ textTracks (List<Track>) [Optional]
      ├─ name (string) [Optional]
      ├─ locale (string) [Optional]
      └─ cues (List<Cue>) [Required]
          ├─ id (string) [Optional]
          ├─ startTimeInSeconds (double) [Required]
          ├─ endTimeInSeconds (double) [Optional]
          └─ text (string) [Required]
  ├─ chapters (List<Chapter>) [Optional]
      ├─ startTimeInSeconds (integer) [Required]
      └─ title (string) [Required]
  └─ contributors (List<Contributor>) [Optional]
      ├─ user (userReference) [Required]
      └─ interactionCount (integer) [Required]

Common properties

Video properties

Example payload

1
2
{
  "schemaVersion": "1.0",
  "id": "video-001",
  "updateSequenceNumber": 1,
  "displayName": "Product Demo Video",
  "description": "A comprehensive product demonstration showcasing key features and capabilities",
  "url": "https://www.loom.com/share/59105659e3b84d2d8491bcc8f608284d",
  "createdAt": "2024-01-15T10:00:00.000Z",
  "lastUpdatedAt": "2024-01-20T14:30:00.000Z",
  "permissions": [{
    "action": "read",
    "accessControls": [{
      "principals": [{
        "type": "EVERYONE"
      }]
    }]
  }, {
    "action": "search",
    "accessControls": [{
      "principals": [{
        "type": "MUST_HAVE_VIEWED"
      }]
    }]
  }],
  "atlassian:video": {
    "thumbnailUrl": "https://cdn.loom.com/sessions/thumbnails/59105659e3b84d2d8491bcc8f608284d-thumbnail.jpg",
    "embedUrl": "https://www.loom.com/embed/59105659e3b84d2d8491bcc8f608284d",
    "durationInSeconds": 503,
    "width": 1920,
    "height": 1080,
    "commentCount": 12,
    "textTracks": [{
      "name": "English subtitles",
      "locale": "en-US",
      "cues": [{
        "id": "cue-intro",
        "startTimeInSeconds": 0,
        "endTimeInSeconds": 5.5,
        "text": "Welcome to our product demonstration. Today we'll be exploring..."
      }, {
        "id": "cue-features",
        "startTimeInSeconds": 90,
        "endTimeInSeconds": 120,
        "text": "Let's take a look at the key features that make this product stand out."
      }]
    }],
    "chapters": [{
      "startTimeInSeconds": 0,
      "title": "Introduction"
    }, {
      "startTimeInSeconds": 90,
      "title": "Key Features"
    }, {
      "startTimeInSeconds": 220,
      "title": "Advanced Capabilities"
    }, {
      "startTimeInSeconds": 350,
      "title": "Conclusion"
    }],
    "contributors": [{
      "user": {
        "externalId": "user-123",
        "email": "demo@example.com"
      },
      "interactionCount": 5
    }, {
      "user": {
        "externalId": "user-456",
        "email": "reviewer@example.com"
      },
      "interactionCount": 3
    }]
  }
}