SharedSpaceEventResponseDto

Endpoints · All schemas

Field	Required	Description
activityId	Yes	The comment or like this event announces, if any
actor	Yes	Who did it; null once that account is gone
assetCount	Yes	How many of the items this event is about the reader may see
assetIds	Yes	The items this event is about that the reader may see and that are still in the shared space. Empty for a removal.
comment	Yes	The comment text, for a comment or reply event. Mentions are @{userId} tokens.
createdAt	Yes	When it happened
id	Yes	Event ID
mentions	Yes	Members named in the comment
subject	Yes	A linked album's or person's name as the space knew it, or the new role; null otherwise
targetUser	Yes	The member a member event is about, or the author of the comment a reply answers; null otherwise
type	Yes	See definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: UserResponseDto, SharedSpaceEventType

{
  "properties": {
    "activityId": {
      "description": "The comment or like this event announces, if any",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "actor": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserResponseDto"
        }
      ],
      "description": "Who did it; null once that account is gone",
      "nullable": true
    },
    "assetCount": {
      "description": "How many of the items this event is about the reader may see",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "assetIds": {
      "description": "The items this event is about that the reader may see and that are still in the shared space. Empty for a removal.",
      "items": {
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        "type": "string"
      },
      "type": "array"
    },
    "comment": {
      "description": "The comment text, for a comment or reply event. Mentions are @{userId} tokens.",
      "nullable": true,
      "type": "string"
    },
    "createdAt": {
      "description": "When it happened",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "Event ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "mentions": {
      "description": "Members named in the comment",
      "items": {
        "$ref": "#/components/schemas/UserResponseDto"
      },
      "type": "array"
    },
    "subject": {
      "description": "A linked album's or person's name as the space knew it, or the new role; null otherwise",
      "nullable": true,
      "type": "string"
    },
    "targetUser": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserResponseDto"
        }
      ],
      "description": "The member a member event is about, or the author of the comment a reply answers; null otherwise",
      "nullable": true
    },
    "type": {
      "$ref": "#/components/schemas/SharedSpaceEventType"
    }
  },
  "required": [
    "activityId",
    "actor",
    "assetCount",
    "assetIds",
    "comment",
    "createdAt",
    "id",
    "mentions",
    "subject",
    "targetUser",
    "type"
  ],
  "type": "object"
}