ChronicleSchema

In other vocabularies

VocabularyTerm
schema.org A kind of BookmarkAction

Properties

PropertyExpected typeDescription
From Action
agent one Agent Who performed the action. An action whose performer is unknown has no agent.
endTime one DateTime When the action ended. A date gives the end at that date's precision and includes the whole period, so 1990 runs to the end of 1990.
instrument many Entity The tool, device, application, or model used to perform an action. The agent is who acted. The instrument is what they used. When only the kind of device is known, it is a ProductModel rather than a Device.
location one Location or Place Where the action happened, or where the entity or event is.
object one Entity The entity an action was carried out on, such as the article read, the photo shared, or the place visited. For a movement, such as a TravelAction, the object is where it began.
result one Entity What the action produced, such as a work or a session. Seen from what it produced, the action is its resultOf value.
startTime one DateTime When the action started. A date gives the start at that date's precision.
target one Entity What an action is directed toward, as distinct from the object it is carried out on. Adding to or removing from a collection targets the collection. A movement targets where it ended, and its object is where it began.
timestamp one DateTime When the action occurred.
From Base
source one Text The source that describes the entity or action, such as things-todo. Identifiers such as sourceId are unique within it.
sourceId one Text The identifier the source gives an entity or action, such as a record ID or message ID. It is unique only within its source.

Examples

Saving a bookmark

A BookmarkAction for one Pinboard bookmark, keyed by Pinboard's hash for the saved url and dated when it was saved.

{
  "@type": "BookmarkAction",
  "@key": ["@type", "source", "sourceId"],
  "source": "pinboard",
  "sourceId": "a8c4e2f9b7314d0e6f25c1b9e3a7d840",
  "timestamp": "2026-05-09T16:04:51.000Z",
  "agent": {
    "@type": "Person",
    "@key": ["@type", "source", "handle"],
    "source": "pinboard",
    "handle": "pat",
    "name": "pat",
    "url": "https://pinboard.in/u:pat/",
    "sameAs": ["@me"]
  },
  "object": {
    "@type": "Entity",
    "@key": ["url", "source"],
    "source": "pinboard",
    "url": "https://trees.example.org/urban-guide",
    "name": "A guide to urban trees",
    "description": "Read before planting season.",
    "about": [
      {
        "@type": "Tag",
        "@key": ["@type", "source", "handle"],
        "source": "pinboard",
        "handle": "trees"
      }
    ]
  }
}

Saving a post to a collection

You saved a post into your Travel collection.

{
  "@type": "BookmarkAction",
  "@key": ["@type", "source", "object.sourceId", "target.name"],
  "source": "instagram",
  "timestamp": "2020-07-03T19:11:47.000Z",
  "agent": {
    "@type": "Agent",
    "@key": ["@type", "source", "handle"],
    "source": "instagram",
    "handle": "sam.rivera",
    "sameAs": ["@me"]
  },
  "object": {
    "@type": "Post",
    "@key": ["@type", "source", "sourceId"],
    "source": "instagram",
    "sourceId": "CExample-B2",
    "url": "https://www.instagram.com/p/CExample-B2/",
    "author": [
      {
        "@type": "Agent",
        "@key": ["@type", "source", "handle"],
        "source": "instagram",
        "handle": "travel.demo",
        "url": "https://www.instagram.com/travel.demo"
      }
    ]
  },
  "target": {
    "@type": "Collection",
    "@key": ["@type", "source", "name"],
    "source": "instagram",
    "name": "Travel"
  }
}

Shelving a book to read

A book on the reader's to-read shelf becomes a BookmarkAction at the date it was added: the reader saved it for later.

{
  "@type": "BookmarkAction",
  "@key": ["@type", "source", "object.sourceId", "timestamp"],
  "source": "goodreads",
  "timestamp": "2025-06-02T00:00:00.000Z",
  "agent": {
    "@type": "Person",
    "@key": ["@type", "source", "name"],
    "source": "goodreads",
    "name": "Sam Rivera",
    "sameAs": ["@me"]
  },
  "object": {
    "@type": "Book",
    "@key": ["@type", "source", "sourceId"],
    "source": "goodreads",
    "sourceId": "51234",
    "name": "Field Notes on Tides",
    "url": "https://www.goodreads.com/book/show/51234",
    "author": [
      {
        "@type": "Person",
        "@key": ["@type", "source", "name"],
        "source": "goodreads",
        "name": "Ines Okafor"
      }
    ]
  }
}

Saving a book to a reference library

A BookmarkAction for a book saved to Zotero.

{
  "@type": "BookmarkAction",
  "@key": ["@type", "source", "object.sourceId", "object.inRealm.handle"],
  "source": "zotero",
  "timestamp": "2024-11-05T10:00:00.000Z",
  "agent": {
    "@type": "Person",
    "@key": ["@type", "source", "sourceId"],
    "source": "zotero",
    "sourceId": "LuK3xAmp",
    "sameAs": ["@me"]
  },
  "object": {
    "@type": "Book",
    "@key": ["source", "sourceId", "inRealm.handle"],
    "source": "zotero",
    "sourceId": "BOOKAAAA",
    "inRealm": {
      "@type": "Realm",
      "@key": ["@type", "source", "handle"],
      "source": "zotero",
      "handle": "7654321"
    },
    "name": "Collected Trails",
    "datePublished": "2019",
    "pageCount": 320,
    "publisher": [
      {
        "@type": "Organization",
        "@key": ["@type", "source", "name"],
        "source": "zotero",
        "name": "Example Press"
      }
    ],
    "author": [
      {
        "@type": "Person",
        "@key": ["@type", "source", "name"],
        "source": "zotero",
        "name": "Pat Example"
      }
    ],
    "creator": [
      {
        "@type": "Person",
        "@key": ["@type", "source", "name"],
        "source": "zotero",
        "name": "Alex Example"
      }
    ],
    "sameAs": [
      {
        "@type": "Book",
        "@key": ["source", "sourceId"],
        "source": "isbn",
        "sourceId": "9780306406157",
        "name": "Collected Trails"
      }
    ]
  }
}

Saving a snapshot of a web page

A BookmarkAction for a web page snapshot saved to Zotero on its own.

{
  "@type": "BookmarkAction",
  "@key": ["@type", "source", "object.sourceId", "object.inRealm.handle"],
  "source": "zotero",
  "timestamp": "2025-02-03T15:20:00.000Z",
  "agent": {
    "@type": "Person",
    "@key": ["@type", "source", "sourceId"],
    "source": "zotero",
    "sourceId": "LuK3xAmp",
    "sameAs": ["@me"]
  },
  "object": {
    "@type": "DocumentObject",
    "@key": ["source", "sourceId", "inRealm.handle"],
    "source": "zotero",
    "sourceId": "SNAPSHOT",
    "inRealm": {
      "@type": "Realm",
      "@key": ["@type", "source", "handle"],
      "source": "zotero",
      "handle": "7654321"
    },
    "name": "Lost Lake Trail",
    "mimeType": "text/html",
    "url": "https://trails.example.com/lost-lake",
    "snapshotOf": [
      {
        "@type": "Entity",
        "@key": ["url"],
        "url": "https://trails.example.com/lost-lake"
      }
    ]
  }
}

Connecting a block to an Are.na channel

You connected an image block into one of your channels on Are.na.

{
  "@type": "BookmarkAction",
  "@key": ["@type", "source", "sourceId"],
  "source": "arena",
  "sourceId": "100",
  "timestamp": "2025-01-10T00:00:00.000Z",
  "agent": {
    "@type": "Agent",
    "@key": ["@type", "source", "sourceId"],
    "source": "arena",
    "sourceId": "1",
    "handle": "pat-example",
    "name": "Pat Example",
    "url": "https://www.are.na/pat-example",
    "emblem": {
      "@type": "ImageObject",
      "@key": ["url"],
      "url": "https://example.com/avatars/pat.png"
    },
    "sameAs": ["@me"]
  },
  "object": {
    "@type": "Post",
    "@key": ["@type", "source", "sourceId"],
    "source": "arena",
    "sourceId": "20",
    "url": "https://www.are.na/block/20",
    "name": "Synthetic photo",
    "body": "A photo",
    "author": [
      {
        "@type": "Agent",
        "@key": ["@type", "source", "sourceId"],
        "source": "arena",
        "sourceId": "1"
      }
    ],
    "references": [
      {
        "@type": "Entity",
        "@key": ["url"],
        "url": "https://example.com/photo"
      }
    ],
    "contains": [
      {
        "@type": "ImageObject",
        "@key": ["url"],
        "url": "https://example.com/images/20.jpg",
        "width": 800,
        "height": 600,
        "caption": "A synthetic photo"
      }
    ]
  },
  "target": {
    "@type": "Collection",
    "@key": ["@type", "source", "sourceId"],
    "source": "arena",
    "sourceId": "10",
    "name": "Mood board",
    "url": "https://www.are.na/pat-example/mood-board",
    "description": "Things I like",
    "visibility": "public"
  }
}

Saving a course

A BookmarkAction for a LinkedIn Learning course you saved.

{
  "@type": "BookmarkAction",
  "@key": ["@type", "source", "object.name"],
  "source": "linkedin",
  "agent": {
    "@type": "Person",
    "@key": ["@type", "source", "handle"],
    "source": "linkedin",
    "handle": "sam-rivera",
    "name": "Sam Rivera",
    "url": "https://www.linkedin.com/in/sam-rivera",
    "sameAs": ["@me"]
  },
  "object": {
    "@type": "CreativeWork",
    "@key": ["@type", "source", "name"],
    "source": "linkedin",
    "name": "Intro to Rust",
    "sourceFormat": "course"
  }
}

URI https://schema.chronicle.app/BookmarkAction · Suggest a change

Esc

↑↓ to move↵ to open/ or ⌘K to search