GET
/
realtime
/
story.created
story created
curl --request GET \
  --url https://apix.us.amity.co/realtime/story.created
{
  "id": "<string>",
  "data": {
    "stories": [
      {
        "storyId": "<string>",
        "path": "<string>",
        "creatorId": "<string>",
        "creatorPublicId": "<string>",
        "targetId": "<string>",
        "targetPublicId": "<string>",
        "targetType": "user",
        "dataType": "text",
        "items": [],
        "data": {
          "text": "<string>",
          "fileId": "<string>",
          "imageDisplayMode": "fit",
          "thumbnailFileId": "<string>",
          "videoFileId": {
            "original": "<string>",
            "low": "<string>",
            "medium": "<string>",
            "high": "<string>"
          }
        },
        "metadata": {},
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "expiresAt": "2023-11-07T05:31:56Z",
        "reactions": {
          "like": 1
        },
        "reactionsCount": 1,
        "myReactions": [
          "like"
        ],
        "commentsCount": 1,
        "isDeleted": false,
        "hasFlaggedComment": false,
        "mentionedUsers": [
          {
            "type": "user",
            "userIds": [
              "<string>"
            ],
            "userPublicIds": [
              "<string>"
            ]
          }
        ],
        "impression": 123,
        "reach": 123
      }
    ],
    "comments": [
      {
        "_id": "<string>",
        "path": "<string>",
        "commentId": "<string>",
        "userId": "<string>",
        "userPublicId": "<string>",
        "userInternalId": "<string>",
        "parentId": "<string>",
        "rootId": "<string>",
        "referenceId": "<string>",
        "referenceType": "post",
        "dataType": "<string>",
        "dataTypes": [
          "text"
        ],
        "data": {},
        "metadata": {},
        "childrenNumber": 123,
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "reactions": {
          "like": 1
        },
        "reactionsCount": 1,
        "myReactions": [
          "like"
        ],
        "isDeleted": false,
        "editedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "children": [
          "<string>"
        ],
        "segmentNumber": 1,
        "mentionees": [
          {
            "type": "user",
            "userIds": [
              "<string>"
            ],
            "userPublicIds": [
              "<string>"
            ],
            "userInternalIds": [
              "<string>"
            ]
          }
        ],
        "attachments": [
          {
            "type": "image",
            "fileId": "<string>"
          }
        ],
        "targetId": "<string>",
        "targetType": "community"
      }
    ],
    "files": [
      {
        "fileId": "<string>",
        "fileUrl": "<string>",
        "type": "image",
        "accessType": "public",
        "altText": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "attributes": {
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mimeType": "<string>",
          "metadata": {
            "exif": {},
            "gps": {},
            "height": 123,
            "width": 123,
            "isFull": true
          }
        }
      }
    ],
    "users": [
      {
        "_id": "<string>",
        "path": "<string>",
        "userId": "<string>",
        "userInternalId": "<string>",
        "userPublicId": "<string>",
        "roles": [
          "<string>"
        ],
        "permissions": [
          "MUTE_CHANNEL"
        ],
        "displayName": "<string>",
        "profileHandle": "<string>",
        "description": "<string>",
        "avatarFileId": "<string>",
        "avatarCustomUrl": "<string>",
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "metadata": {},
        "isGlobalBan": true,
        "isBrand": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isDeleted": true
      }
    ],
    "communities": [
      {
        "_id": "<string>",
        "path": "<string>",
        "communityId": "<string>",
        "channelId": "<string>",
        "userId": "<string>",
        "userPublicId": "<string>",
        "userInternalId": "<string>",
        "displayName": "<string>",
        "avatarFileId": "<string>",
        "description": "<string>",
        "isOfficial": true,
        "isPublic": true,
        "onlyAdminCanPost": true,
        "tags": [
          "<string>"
        ],
        "metadata": {},
        "postsCount": 123,
        "membersCount": 123,
        "isJoined": true,
        "categoryIds": [
          "<string>"
        ],
        "isDeleted": false,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "hasFlaggedComment": false,
        "hasFlaggedPost": false,
        "needApprovalOnPostCreation": false,
        "moderatorMemberCount": 123,
        "allowCommentInStory": true,
        "isDiscoverable": false,
        "requiresJoinApproval": false,
        "notificationMode": "default"
      }
    ],
    "communityUsers": [
      {
        "userId": "<string>",
        "userPublicId": "<string>",
        "userInternalId": "<string>",
        "channelId": "<string>",
        "communityId": "<string>",
        "communityMembership": "none",
        "notMemberReason": "<string>",
        "isBanned": false,
        "lastActivity": "2023-11-07T05:31:56Z",
        "roles": [
          "<string>"
        ],
        "permissions": [
          "MUTE_CHANNEL"
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "categories": [
      {
        "categoryId": "<string>",
        "name": "<string>",
        "metadata": {},
        "avatarFileId": "<string>",
        "isDeleted": false,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "networkId": "<string>",
  "path": "<string>",
  "eventType": "<string>",
  "senderId": "<string>",
  "sendTime": "2023-11-07T05:31:56Z",
  "version": "<string>"
}

Response

200 - application/json

Story Information

The response is of type object.