Notification
| Field | Type | Description |
|---|---|---|
id |
int |
Unique identifier for the notification. |
question_id |
int|null |
Unique identifier for the question this notification refers to, or null if the notification does not refer to a specific question. |
content |
string(plain text with mentioning markup) |
Content of the notification subject, in plain text (HTML stripped) but possibly with mentioning markup. |
personal_message |
string|null |
Personal message as part of share (question, solution, recommend expert) if present otherwise null. |
icon |
URL |
URL of the icon that can be displayed with this notification. |
url |
resource |
Relative path to the target of this notification. |
target_type |
string |
One of question, solution, comment or user_profile. |
target_id |
int|null |
If the target_type is question, solution or comment, then this field contains the id of the referred question, solution or comment respectively. If there is no target id, then this field is null. |
is_read |
boolean |
Indicates if the user has read the notification. This implies that the notification has also be seen. |
is_seen |
boolean |
Indicates if the user has seen the notification. |
type |
string |
The notification type. Please find all possible notification types in the Notification Type section |
user |
resource |
The user that has triggered the notification. If no user is available, this will be set to null. |
created |
datetime |
Creation date of the notification. |
{
"id": 21,
"question_id": 10931,
"content": "You'll never know..",
"personal_message": null,
"icon": "https://cdn.example.com/avatar/default/2d/1b84215e2f035a22f6fec213d3b1d9.jpg",
"url": "/question/10931/is-there-a-study-in-scarlet",
"target_type": "solution",
"target_id": 912,
"is_seen": true,
"is_read": true,
"type": "new_solution",
"user": {
"image": "https://cdn.example.com/static/user/default.jpg",
"firstname": "Sherlock",
"is_deleted": false,
"lastname": "Holmes",
"id": 17310,
"email": "sherlock.holmes@example.com",
"location": "London",
"customfields": { "occupation": "Detective" }
},
"created": "2014-10-07T08:45:20.000Z"
}
Notification Types
A mapping and description of all possible notifications a user could receive.
In the table below, "you" always refers to the user who receives the notification.
For some notification types, whether there is a referring user or not is decided by the concept of question poser anonymity.
| Type | Description | Referring user |
|---|---|---|
new_comment_to_question |
A new comment to a question has been posed | The comment author (if different from the question poser) |
new_comment_to_your_question |
A new comment to your question has been posed | The comment author |
new_comment_to_solution |
A new comment to a solution has been posed | The comment author (if different from the question poser) |
new_comment_to_your_solution |
A new comment to your solution has been posed | The comment author (if different from the question poser) |
new_solution |
A solution has been added | The solution author |
new_solution_to_your_question |
A solution has been added to your question | The solution author |
solution_rated |
A solution has been rated | / |
solution_rated_by_question_poser |
A solution has been rated | / |
new_question |
You have been selected as an expert for a new question | / |
new_question_random_user |
A new question that potentially might interest you | / |
question_forwarded |
A question has been forwarded to you | The user who sent the question to you |
question_forwarded_inactive |
A question has been forwarded to you, while your user was not yet activated | The user who sent the question to you |
solution_from_comment |
A comment has been converted into a solution | / |
question_changed_to_solution_author |
A question that you have solved has been significantly edited | / |
solution_changed_to_question_poser |
A solution to your question has been significantly edited | The solution author |
solution_changed_to_solution_rater |
A solution that you have rated has been significantly edited | The solution author |
validation_request |
A validation has been requested for your solution | / |
validation |
A previously expired solution was validated | The solution author |
validation_to_your_question |
A previously expired solution to your question was validated | The solution author |
validation_new_expert |
You have been selected as an expert to provide a new solution for a question with expired solutions, for which a solution validation was requested | / |
tag_subscription |
New question with a tag that you have subscribed to | / |
new_user_score_level_reached |
You have reached a new level in the gamification mode | / |
mention_in_question |
You have been mentioned in a question | / |
mention_in_solution |
The user has been mentioned in a solution | The solution author |
mention_in_comment |
The user has been mentioned in a comment | The comment author (if different from the question poser, or if it's a comment to a solution which the comment author wrote himself) |
share_question |
A question has been shared with you | The user who shared the question |
share_solution |
A solution has been shared with you | The user who shared the solution |
