org.hypercerts.claim.activity Documentation (EN)

main record

A hypercert record tracking impact work.

Record Key any Any valid record key

Properties

contributors array of ref #contributor Optional

An array of contributor objects, each containing contributor information, weight, and contribution details.

createdAt string datetime Required

Client-declared timestamp when this record was originally created

description union Optional

Long-form description of the activity. An inline string for plain text or markdown, a Leaflet linear document for rich-text content, or a strong reference to an external description record.

Known types:

endDate string datetime Optional

When the work ended

image union Optional

The hypercert visual representation as a URI or image blob.

Known types:

locations array of ref com.atproto.repo.strongRef Optional

An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location.

maxLength: 1000 items

rights ref com.atproto.repo.strongRef Optional

A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights.

shortDescription string Required

Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

shortDescriptionFacets array of ref app.bsky.richtext.facet Optional

Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).

startDate string datetime Optional

When the work began

title string Required

Display title summarizing the impact work (e.g. 'Reforestation in Amazon Basin 2024')

maxLength: 256 bytes

workScope union Optional

Work scope definition. A CEL expression for structured, machine-evaluable scopes or a free-form string for simple and legacy scopes.

Known types:

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "shortDescription",
      "createdAt"
    ],
    "properties": {
      "image": {
        "refs": [
          "org.hypercerts.defs#uri",
          "org.hypercerts.defs#smallImage"
        ],
        "type": "union",
        "description": "The hypercert visual representation as a URI or image blob."
      },
      "title": {
        "type": "string",
        "maxLength": 256,
        "description": "Display title summarizing the impact work (e.g. 'Reforestation in Amazon Basin 2024')"
      },
      "rights": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "A strong reference to the rights that this hypercert has. The record referenced must conform with the lexicon org.hypercerts.claim.rights."
      },
      "endDate": {
        "type": "string",
        "format": "datetime",
        "description": "When the work ended"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when this record was originally created"
      },
      "locations": {
        "type": "array",
        "items": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        },
        "maxLength": 1000,
        "description": "An array of strong references to the location where activity was performed. The record referenced must conform with the lexicon app.certified.location."
      },
      "startDate": {
        "type": "string",
        "format": "datetime",
        "description": "When the work began"
      },
      "workScope": {
        "refs": [
          "org.hypercerts.workscope.cel",
          "#workScopeString"
        ],
        "type": "union",
        "description": "Work scope definition. A CEL expression for structured, machine-evaluable scopes or a free-form string for simple and legacy scopes."
      },
      "description": {
        "refs": [
          "org.hypercerts.defs#descriptionString",
          "pub.leaflet.pages.linearDocument",
          "com.atproto.repo.strongRef"
        ],
        "type": "union",
        "description": "Long-form description of the activity. An inline string for plain text or markdown, a Leaflet linear document for rich-text content, or a strong reference to an external description record."
      },
      "contributors": {
        "type": "array",
        "items": {
          "ref": "#contributor",
          "type": "ref"
        },
        "description": "An array of contributor objects, each containing contributor information, weight, and contribution details."
      },
      "shortDescription": {
        "type": "string",
        "maxLength": 3000,
        "description": "Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.",
        "maxGraphemes": 300
      },
      "shortDescriptionFacets": {
        "type": "array",
        "items": {
          "ref": "app.bsky.richtext.facet",
          "type": "ref"
        },
        "description": "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc)."
      }
    }
  },
  "description": "A hypercert record tracking impact work."
}

contributor object

A contributor to the activity, with identity, weight, and contribution details.

Properties

contributionDetails union Optional

Inline contribution role object with a role string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record. The record referenced must conform with the lexicon org.hypercerts.claim.contribution.

Known types:

contributionWeight string Optional

The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed.

maxLength: 100 bytes

contributorIdentity union Required

Inline contributor identity object with an identity string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record. The record referenced must conform with the lexicon org.hypercerts.claim.contributorInformation.

Known types:

View raw schema

{
  "type": "object",
  "required": [
    "contributorIdentity"
  ],
  "properties": {
    "contributionWeight": {
      "type": "string",
      "maxLength": 100,
      "description": "The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
    },
    "contributionDetails": {
      "refs": [
        "#contributorRole",
        "com.atproto.repo.strongRef"
      ],
      "type": "union",
      "description": "Inline contribution role object with a role string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record. The record referenced must conform with the lexicon org.hypercerts.claim.contribution."
    },
    "contributorIdentity": {
      "refs": [
        "#contributorIdentity",
        "com.atproto.repo.strongRef"
      ],
      "type": "union",
      "description": "Inline contributor identity object with an identity string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record. The record referenced must conform with the lexicon org.hypercerts.claim.contributorInformation."
    }
  },
  "description": "A contributor to the activity, with identity, weight, and contribution details."
}

contributorIdentity object

Contributor information as a string (DID or identifier).

Properties

identity string Required

The contributor identity string (DID or identifier).

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

View raw schema

{
  "type": "object",
  "required": [
    "identity"
  ],
  "properties": {
    "identity": {
      "type": "string",
      "maxLength": 1000,
      "description": "The contributor identity string (DID or identifier).",
      "maxGraphemes": 100
    }
  },
  "description": "Contributor information as a string (DID or identifier)."
}

contributorRole object

Contribution details as a string.

Properties

role string Required

The contribution role or details.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

View raw schema

{
  "type": "object",
  "required": [
    "role"
  ],
  "properties": {
    "role": {
      "type": "string",
      "maxLength": 1000,
      "description": "The contribution role or details.",
      "maxGraphemes": 100
    }
  },
  "description": "Contribution details as a string."
}

workScopeString object

A free-form string describing the work scope for simple or legacy scopes.

Properties

scope string Required

The work scope description string.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

View raw schema

{
  "type": "object",
  "required": [
    "scope"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "maxLength": 1000,
      "description": "The work scope description string.",
      "maxGraphemes": 100
    }
  },
  "description": "A free-form string describing the work scope for simple or legacy scopes."
}