Skip to main content

Activity

KeyTypeDescriptionOptional
idstringUnique identifier for the activity.
actionActivityActionTypeAction type associated with the activity.
actionBystring[]List of user IDs who performed the action.
actionOnstringTarget entity of the action (e.g., a post or comment).
activityEntityDataActivityEntityDataDetails of the entity related to the activity.
activityTextstringDescriptive text about the activity.
createdAtnumberTimestamp for when the activity was created.
ctastringCall to action associated with the activity.
entityIdstringID of the related entity.
entityOwnerIdstringID of the owner of the related entity.
entityTypeActivityEntityTypeType of the entity (e.g., post, comment, etc.).
isReadbooleanWhether the activity has been marked as read.
updatedAtnumberTimestamp for the last update to the activity.
uuidstringUnique identifier for the activity (UUID format).

Activity Entity Data

KeyTypeDescriptionOptional
idstringUnique identifier for the entity associated with the activity.
attachmentsAttachment[]List of attachments related to the activity.
commentIdsnullCurrently set to null, can represent a list of comment IDs in the future.✔️
commentsCountnumberTotal number of comments on the entity.
communityIdnumberID of the community where the activity occurred.
createdAtnumberTimestamp for when the entity was created.
deleteReasonstringReason for deletion, if applicable.✔️
deletedBystringID of the user who deleted the entity, if applicable.✔️
deletedByUuidstringUUID of the user who deleted the entity, if applicable.✔️
headingstringHeading or title of the entity.
isDeletedbooleanWhether the entity has been deleted.✔️
isEditedbooleanWhether the entity has been edited.
isLikedbooleanWhether the entity is liked by the user.
isPinnedbooleanWhether the entity is pinned.
isRepostbooleanWhether the entity is a repost.
isRepostedByUserbooleanWhether the entity has been reposted by the current user.
isSavedbooleanWhether the entity is saved by the user.
likesCountnumberNumber of likes on the entity.
menuItemsMenuItem[]Menu items available for the entity.
repostCountnumberNumber of reposts of the entity.
tempIdstring | nullTemporary ID used for internal operations, can be null.✔️
textstringText content of the entity.
topicsstring[]Topics related to the entity.
updatedAtnumberTimestamp for when the entity was last updated.
userIdstringID of the user who created the entity.
uuidstringUUID of the entity.

ActivityActionType

ValueDescription
CREATE_POST_PERMIT_ADDEDCreate post permit added.
CREATE_POST_PERMIT_REMOVEDCreate post permit removed.
CREATE_COMMENT_PERMIT_ADDEDCreate comment permit added.
CREATE_COMMENT_PERMIT_REMOVEDCreate comment permit removed.
CM_DELETED_YOUR_POSTCommunity manager deleted your post.
CM_DELETED_YOUR_COMMENTCommunity manager deleted your comment.
LIKE_ON_YOUR_POSTSomeone liked your post.
COMMENT_ON_YOUR_POSTSomeone commented on your post.
LIKE_ON_YOUR_COMMENTSomeone liked your comment.
COMMENT_ON_YOUR_COMMENTSomeone commented on your comment.
TAGGED_YOU_ON_POSTYou were tagged in a post.
TAGGED_YOU_ON_COMMENTYou were tagged in a comment.
ALSO_COMMENTED_ON_POST_YOU_COMMENTEDSomeone also commented on a post you commented on.
REPOSTED_YOUR_POSTSomeone reposted your post.
LIKE_ON_POSTLike on a post.
LIKE_ON_COMMENTLike on a comment.
COMMENT_ON_POSTComment on a post.
COMMENT_ON_COMMENTComment on a comment.

ActivityEntityType

ValueDescription
POSTRepresents a post.
COMMENTRepresents a comment.
USERRepresents a user.
PENDING_POSTRepresents a pending post.