Notifications

Personas in this Story: Default, Member.

When we check our notifications stream, we'll see that is empty:

Response: HTTP 200, application/json (Hide)

GET /notifications

Response:

1
2
3
4
{
    "notifications": [],
    "related": []
}

Now, a member came and created a task for us:

Response: HTTP 200, application/json (Hide)

POST /projects/1/tasks (as Member)

Payload:

1
2
3
4
{
    "name": "One hundred push ups",
    "assignee_id": 1
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
    "single": {
        "id": 1,
        "class": "Task",
        "url_path": "\/projects\/1\/tasks\/1",
        "name": "One hundred push ups",
        "assignee_id": 1,
        "delegated_by_id": 2,
        "completed_on": null,
        "completed_by_id": null,
        "is_completed": false,
        "comments_count": 0,
        "attachments": [],
        "labels": [],
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "project_id": 1,
        "is_hidden_from_clients": false,
        "body": "",
        "body_formatted": "",
        "created_on": 1430164927,
        "created_by_id": 2,
        "updated_on": 1430164927,
        "updated_by_id": 2,
        "task_number": 1,
        "task_list_id": 0,
        "position": 1,
        "is_important": false,
        "due_on": null,
        "estimate": 0,
        "job_type_id": 0,
        "total_subtasks": 0,
        "completed_subtasks": 0,
        "open_subtasks": 0
    },
    "subscribers": [
        1,
        2
    ],
    "comments": [],
    "reminders": [],
    "subtasks": [],
    "task_list": null,
    "tracked_time": 0,
    "tracked_expenses": 0
}

and we'll see this notification in our notifications stream:

Response: HTTP 200, application/json (Hide)

GET /notifications

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    "notifications": [
        {
            "id": 2,
            "class": "NewTaskNotification",
            "url_path": "\/notifications\/2",
            "parent_type": "Task",
            "parent_id": 1,
            "created_on": 1430164927,
            "sender_id": 2
        }
    ],
    "related": {
        "Task": {
            "1": {
                "id": 1,
                "class": "Task",
                "url_path": "\/projects\/1\/tasks\/1",
                "name": "One hundred push ups",
                "assignee_id": 1,
                "delegated_by_id": 2,
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "comments_count": 0,
                "attachments": [],
                "labels": [],
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "project_id": 1,
                "is_hidden_from_clients": false,
                "body": "",
                "body_formatted": "",
                "created_on": 1430164927,
                "created_by_id": 2,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "task_number": 1,
                "task_list_id": 0,
                "position": 1,
                "is_important": false,
                "due_on": null,
                "estimate": 0,
                "job_type_id": 0,
                "total_subtasks": 0,
                "completed_subtasks": 0,
                "open_subtasks": 0
            }
        },
        "Project": {
            "1": {
                "id": 1,
                "class": "Project",
                "url_path": "\/projects\/1",
                "name": "Test Project",
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "members": [
                    1,
                    2
                ],
                "category_id": 0,
                "label_id": 0,
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "created_on": 1430164926,
                "created_by_id": 1,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "body": null,
                "body_formatted": "",
                "company_id": 1,
                "leader_id": 1,
                "currency_id": 2,
                "template_id": 0,
                "based_on_type": null,
                "based_on_id": null,
                "email": "notifications+m2p-VFx7Q3c@mail.manageprojects.com",
                "is_tracking_enabled": true,
                "is_client_reporting_enabled": false,
                "budget": null,
                "count_tasks": 1,
                "count_discussions": 0,
                "count_files": 0,
                "count_notes": 0
            }
        }
    }
}

This response shows user notifications:

Response: HTTP 200, application/json (Hide)

GET /notifications

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    "notifications": [
        {
            "id": 2,
            "class": "NewTaskNotification",
            "url_path": "\/notifications\/2",
            "parent_type": "Task",
            "parent_id": 1,
            "created_on": 1430164927,
            "sender_id": 2
        }
    ],
    "related": {
        "Task": {
            "1": {
                "id": 1,
                "class": "Task",
                "url_path": "\/projects\/1\/tasks\/1",
                "name": "One hundred push ups",
                "assignee_id": 1,
                "delegated_by_id": 2,
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "comments_count": 0,
                "attachments": [],
                "labels": [],
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "project_id": 1,
                "is_hidden_from_clients": false,
                "body": "",
                "body_formatted": "",
                "created_on": 1430164927,
                "created_by_id": 2,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "task_number": 1,
                "task_list_id": 0,
                "position": 1,
                "is_important": false,
                "due_on": null,
                "estimate": 0,
                "job_type_id": 0,
                "total_subtasks": 0,
                "completed_subtasks": 0,
                "open_subtasks": 0
            }
        },
        "Project": {
            "1": {
                "id": 1,
                "class": "Project",
                "url_path": "\/projects\/1",
                "name": "Test Project",
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "members": [
                    1,
                    2
                ],
                "category_id": 0,
                "label_id": 0,
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "created_on": 1430164926,
                "created_by_id": 1,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "body": null,
                "body_formatted": "",
                "company_id": 1,
                "leader_id": 1,
                "currency_id": 2,
                "template_id": 0,
                "based_on_type": null,
                "based_on_id": null,
                "email": "notifications+m2p-VFx7Q3c@mail.manageprojects.com",
                "is_tracking_enabled": true,
                "is_client_reporting_enabled": false,
                "budget": null,
                "count_tasks": 1,
                "count_discussions": 0,
                "count_files": 0,
                "count_notes": 0
            }
        }
    }
}

and this one shows notifications that are not yet seen by the user:

Response: HTTP 200, application/json (Hide)

GET /notifications/unread

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    "notifications": [
        {
            "id": 2,
            "class": "NewTaskNotification",
            "url_path": "\/notifications\/2",
            "parent_type": "Task",
            "parent_id": 1,
            "created_on": 1430164927,
            "sender_id": 2
        }
    ],
    "related": {
        "Task": {
            "1": {
                "id": 1,
                "class": "Task",
                "url_path": "\/projects\/1\/tasks\/1",
                "name": "One hundred push ups",
                "assignee_id": 1,
                "delegated_by_id": 2,
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "comments_count": 0,
                "attachments": [],
                "labels": [],
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "project_id": 1,
                "is_hidden_from_clients": false,
                "body": "",
                "body_formatted": "",
                "created_on": 1430164927,
                "created_by_id": 2,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "task_number": 1,
                "task_list_id": 0,
                "position": 1,
                "is_important": false,
                "due_on": null,
                "estimate": 0,
                "job_type_id": 0,
                "total_subtasks": 0,
                "completed_subtasks": 0,
                "open_subtasks": 0
            }
        },
        "Project": {
            "1": {
                "id": 1,
                "class": "Project",
                "url_path": "\/projects\/1",
                "name": "Test Project",
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "members": [
                    1,
                    2
                ],
                "category_id": 0,
                "label_id": 0,
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "created_on": 1430164926,
                "created_by_id": 1,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "body": null,
                "body_formatted": "",
                "company_id": 1,
                "leader_id": 1,
                "currency_id": 2,
                "template_id": 0,
                "based_on_type": null,
                "based_on_id": null,
                "email": "notifications+m2p-VFx7Q3c@mail.manageprojects.com",
                "is_tracking_enabled": true,
                "is_client_reporting_enabled": false,
                "budget": null,
                "count_tasks": 1,
                "count_discussions": 0,
                "count_files": 0,
                "count_notes": 0
            }
        }
    }
}

After we visit the task:

Response: HTTP 200, application/json (Hide)

GET /projects/1/tasks/1

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
    "single": {
        "id": 1,
        "class": "Task",
        "url_path": "\/projects\/1\/tasks\/1",
        "name": "One hundred push ups",
        "assignee_id": 1,
        "delegated_by_id": 2,
        "completed_on": null,
        "completed_by_id": null,
        "is_completed": false,
        "comments_count": 0,
        "attachments": [],
        "labels": [],
        "is_trashed": false,
        "trashed_on": null,
        "trashed_by_id": 0,
        "project_id": 1,
        "is_hidden_from_clients": false,
        "body": "",
        "body_formatted": "",
        "created_on": 1430164927,
        "created_by_id": 2,
        "updated_on": 1430164927,
        "updated_by_id": 2,
        "task_number": 1,
        "task_list_id": 0,
        "position": 1,
        "is_important": false,
        "due_on": null,
        "estimate": 0,
        "job_type_id": 0,
        "total_subtasks": 0,
        "completed_subtasks": 0,
        "open_subtasks": 0
    },
    "subscribers": [
        1,
        2
    ],
    "comments": [],
    "reminders": [],
    "subtasks": [],
    "task_list": null,
    "tracked_time": 0,
    "tracked_expenses": 0
}

Regular /notifications listing will remain the same:

Response: HTTP 200, application/json (Hide)

GET /notifications

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    "notifications": [
        {
            "id": 2,
            "class": "NewTaskNotification",
            "url_path": "\/notifications\/2",
            "parent_type": "Task",
            "parent_id": 1,
            "created_on": 1430164927,
            "sender_id": 2
        }
    ],
    "related": {
        "Task": {
            "1": {
                "id": 1,
                "class": "Task",
                "url_path": "\/projects\/1\/tasks\/1",
                "name": "One hundred push ups",
                "assignee_id": 1,
                "delegated_by_id": 2,
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "comments_count": 0,
                "attachments": [],
                "labels": [],
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "project_id": 1,
                "is_hidden_from_clients": false,
                "body": "",
                "body_formatted": "",
                "created_on": 1430164927,
                "created_by_id": 2,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "task_number": 1,
                "task_list_id": 0,
                "position": 1,
                "is_important": false,
                "due_on": null,
                "estimate": 0,
                "job_type_id": 0,
                "total_subtasks": 0,
                "completed_subtasks": 0,
                "open_subtasks": 0
            }
        },
        "Project": {
            "1": {
                "id": 1,
                "class": "Project",
                "url_path": "\/projects\/1",
                "name": "Test Project",
                "completed_on": null,
                "completed_by_id": null,
                "is_completed": false,
                "members": [
                    1,
                    2
                ],
                "category_id": 0,
                "label_id": 0,
                "is_trashed": false,
                "trashed_on": null,
                "trashed_by_id": 0,
                "created_on": 1430164926,
                "created_by_id": 1,
                "updated_on": 1430164927,
                "updated_by_id": 2,
                "body": null,
                "body_formatted": "",
                "company_id": 1,
                "leader_id": 1,
                "currency_id": 2,
                "template_id": 0,
                "based_on_type": null,
                "based_on_id": null,
                "email": "notifications+m2p-VFx7Q3c@mail.manageprojects.com",
                "is_tracking_enabled": true,
                "is_client_reporting_enabled": false,
                "budget": null,
                "count_tasks": 1,
                "count_discussions": 0,
                "count_files": 0,
                "count_notes": 0
            }
        }
    }
}

but /notifications/unread will become empty:

Response: HTTP 200, application/json (Hide)

GET /notifications/unread

Response:

1
2
3
4
{
    "notifications": [],
    "related": []
}