ActivitiesNotification - Huddle/huddle-apis GitHub Wiki

Activities Notification

Summary

Get user activities.

Status

Operation Status
Get all activities by a user Live
Get all activities by a user and workspace Live

Get all activities by a user

You can GET all activities by a given number of count for a user with the Bearer access token.

Example

Request:

GET /notifications/activities?count={count} HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "Data": [
        {
            "DateAdded": {
                "Day": 25,
                "FormattedDate": "25/10/2023 06:27",
                "Hour": 6,
                "Minute": 27,
                "Month": 10,
                "Year": 2023
            },
            "Description": "",
            "DisplayName": "John Doe",
            "Operation": "Create",
            "TargetId": 1038,
            "TargetText": "Huddle for Sales teams",
            "TargetType": "Document",
            "UpdatedItemDataType": "document",
            "Uri": "files/1038",
            "UserAvatar": "https://my.huddle.q3/apigateway/files/users/3433/avatar?h=5JDw8yk1De0UOLKvYgoxz-WoaEYjFGD5u0fkjl-qJc8",
            "UserId": 3433,
            "VersionNumber": 1,
            "WorkspaceId": 3435,
            "WorkspaceTitle": "Your first workspace",
            "NewsFeedItemId": 1257,
            "UserRelativeUri": "~/user/john.doe
        }
    ],
    "Success": true,
    "Error": null
}

Get all activities by a user and workspace

You can GET all activities by a given workspace ID and number of count for a user with the Bearer access token.

Request:

GET /notifications/activities?workspaceId={workspaceId}&count={count} HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "Data": [
        {
            "DateAdded": {
                "Day": 25,
                "FormattedDate": "25/10/2023 06:27",
                "Hour": 6,
                "Minute": 27,
                "Month": 10,
                "Year": 2023
            },
            "Description": "",
            "DisplayName": "John Doe",
            "Operation": "Create",
            "TargetId": 1038,
            "TargetText": "Huddle for Sales teams",
            "TargetType": "Document",
            "UpdatedItemDataType": "document",
            "Uri": "files/1038",
            "UserAvatar": "https://my.huddle.q3/apigateway/files/users/3433/avatar?h=5JDw8yk1De0UOLKvYgoxz-WoaEYjFGD5u0fkjl-qJc8",
            "UserId": 3433,
            "VersionNumber": 1,
            "WorkspaceId": 3435,
            "WorkspaceTitle": "Your first workspace",
            "NewsFeedItemId": 1257,
            "UserRelativeUri": "~/user/john.doe
        }
    ],
    "Success": true,
    "Error": null
}

Error Responses

Case Response Code Error Code
Invalid access token 401 Unauthorized invalid_token
Any error with default values 404 Bad Request ResourceMatchingFailed