You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 1, 2017. It is now read-only.
Copy file name to clipboardExpand all lines: content/v3/activity/notifications.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,14 @@ title: Notifications | GitHub API
7
7
* TOC
8
8
{:toc}
9
9
10
-
GitHub Notifications are powered by[watched repositories](/v3/activity/watching/).
11
-
Users receive notifications for discussions in repositories they watch
10
+
Users receive notifications for conversations in repositories they watch
12
11
including:
13
12
14
13
* Issues and their comments
15
14
* Pull Requests and their comments
16
15
* Comments on any commits
17
16
18
-
Notifications are also sent fordiscussions in unwatched repositories when the
17
+
Notifications are also sent forconversations in unwatched repositories when the
19
18
user is involved including:
20
19
21
20
***@mentions**
@@ -59,20 +58,20 @@ Here's a list of potential `reason`s for receiving a notification:
59
58
Reason Name | Description
60
59
------------|------------
61
60
`subscribed` | The notification arrived because you're watching the repository
62
-
`manual` | The notification arrived because you've specifically decided towatchtheitem (via an Issue or Pull Request)
63
-
`author` | The notification arrived because you've created theitem
64
-
`comment` | The notification arrived because you've commented on theitem
65
-
`mention` | The notification arrived because you were specifically**@mentioned** in the content
66
-
`team_mention` | The notification arrived because you were on a team that was mentioned (like@org/team)
67
-
`state_change` | The notification arrived because you changed theitem state (like closing an Issue or merging a Pull Request)
68
-
`assign` | The notification arrived because you were assigned to the Issue
61
+
`manual` | The notification arrived because you've specifically decided tosubscribe tothethread (via an Issue or Pull Request)
62
+
`author` | The notification arrived because you've created thethread
63
+
`comment` | The notification arrived because you've commented on thethread
64
+
`mention` | The notification arrived because you were specifically**@mentioned** in the content
65
+
`team_mention` | The notification arrived because you were on a team that was mentioned (like@org/team)
66
+
`state_change` | The notification arrived because you changed thethread state (like closing an Issue or merging a Pull Request)
67
+
`assign` | The notification arrived because you were assigned to the Issue
69
68
70
69
Note that the`reason` is modified on a per-thread basis, and can change, if the
71
-
`reason` on a later notification is different.
70
+
`reason` on a later notification is different.
72
71
73
-
For example, if you are the author of an issue, subsequent notifications on that
74
-
issue will have a`reason` of`author`. If you're then**@mentioned** on the same
75
-
issue, the notifications you fetch thereafter will have a`reason` of`mention`.
72
+
For example, if you are the author of an issue, subsequent notifications on that
73
+
issue will have a`reason` of`author`. If you're then**@mentioned** on the same
74
+
issue, the notifications you fetch thereafter will have a`reason` of`mention`.
76
75
The`reason` remains as`mention`, regardless of whether you're ever mentioned again.
77
76
78
77
##List your notifications
@@ -142,7 +141,7 @@ from the [default view on GitHub.com](https://github.com/notifications).
142
141
143
142
###Parameters
144
143
145
-
Name | Type | Description
144
+
Name | Type | Description
146
145
-----|------|--------------
147
146
`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format:`YYYY-MM-DDTHH:MM:SSZ`. Default:`Time.now`
148
147
@@ -173,6 +172,12 @@ Name | Type | Description
173
172
This checks to see if the current user is subscribed to a thread. You can also
174
173
[get a Repository subscription](/v3/activity/watching/#get-a-repository-subscription).
175
174
175
+
{{#tip}}
176
+
177
+
Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were**@mention**ed, or manually subscribe to a thread.
178
+
179
+
{{/tip}}
180
+
176
181
GET /notifications/threads/:id/subscription
177
182
178
183
###Response
@@ -182,10 +187,7 @@ This checks to see if the current user is subscribed to a thread. You can also
182
187
183
188
##Set a Thread Subscription
184
189
185
-
This lets you subscribe to a thread, or ignore it. Subscribing to a thread
186
-
is unnecessary if the user is already subscribed to the repository. Ignoring
187
-
a thread will mute all future notifications (until you comment or get
188
-
@mentioned).
190
+
This lets you subscribe or unsubscribe from a conversation. Unsubscribing from a conversation mutes all future notifications (until you comment or get**@mention**ed once more).