Type inbox_item

Discussion

This type represents an item in a user's Global Inbox.

Be aware that the types of items returned by this method are subject to change at any time. In particular, new types may be introduced without warning. Applications should deal with these changes gracefully.

Applications should not publish a user's inbox without their explicit consent, as while most item types are public in nature there are a few which are (and should remain) private.

Fields

answer_id
integer, refers to an answer
may be absent

body
string
unchanged in unsafe filters
may be absent

comment_id
integer, refers to a comment
may be absent

creation_date

is_unread
boolean

item_type
one of comment, chat_message, new_answer, careers_message, careers_invitations, meta_question, post_notice, or moderator_message

link
string
unchanged in unsafe filters

question_id
integer, refers to a question
may be absent

title
string

Fields marked with are included in the default filter, those marked with are excluded in the default filter.

Examples

Comment On Question

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"comment_id":1,"question_id":1,"item_type":"comment","link":"http://example.stackexchange.com/posts/comments/1","body":"part of example comment","title":"Example Question Title"}

Comment On Answer

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"comment_id":1,"answer_id":1,"item_type":"comment","link":"http://example.stackexchange.com/posts/comments/1","body":"part of example comment","title":"Example Question Title"}

New Answer

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"answer_id":2,"question_id":1,"item_type":"new_answer","link":"http://example.stackexchange.com/questions/1/example-question-title/2#2","body":"part of the example answer","title":"Example Question Title"}

New Meta Question

{"site":{"site_state":"linked_meta","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://meta.example.stackexchange.com","api_site_parameter":"meta.example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Meta Example Site","site_type":"meta_site"},"is_unread":false,"creation_date":1397852572,"question_id":1,"item_type":"meta_question","link":"http://meta.example.stackexchange.com/questions/1/example-question-title","body":"part of the example question","title":"Example Question Title"}

Chat Message*

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"item_type":"chat_message","link":"http://chat.example.stackexchange.com/transcript/message/1234#1234","body":"part of the example chat message","title":"Example Room Name"}

Careers Invitations*

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"item_type":"careers_invitations","link":"http://careers.example.stackexchange.com/cv/invitations/1","title":"You have been granted 42 Careers 2.0 profile in..."}

Careers Message*

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"item_type":"careers_message","link":"http://careers.example.stackexchange.com/cv/messages/1","body":"part of the example message","title":"Example Company"}

Post Notice on Question

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"question_id":2345,"item_type":"post_notice","link":"http://example.stackexchange.com/q/2345","body":"part of the notice message...","title":"Involved Question Title"}

Post Notice on Answer

{"site":{"launch_date":1397938972,"open_beta_date":1397852572,"closed_beta_date":1397766172,"site_state":"normal","icon_url":"http://sstatic.net/stackexchange/img/apple-touch-icon.png","audience":"example lovers","site_url":"http://example.stackexchange.com","api_site_parameter":"example","logo_url":"http://sstatic.net/stackexchange/img/logo.png","name":"Example Site","site_type":"main_site"},"is_unread":false,"creation_date":1397852572,"answer_id":6789,"question_id":2345,"item_type":"post_notice","link":"http://example.stackexchange.com/a/6789","body":"part of the notice message...","title":"Involved Question Title"}
*Messages originating from non-Q&A sites or their metas have site fields of the associated Q&A site. Careers considers Stack Overflow to be it's associated site.

Methods That Return This Type