{"_id":"546be32e55639108002b184a","__v":22,"project":"545137a814af501a00b50cf9","category":{"_id":"546b9072b47b5d1400109edf","project":"545137a814af501a00b50cf9","version":"545137a814af501a00b50cfc","__v":6,"pages":["546bdfb555639108002b1842","546be31f52812008000414af","546be32e55639108002b184a","546be33c52812008000414b1","546be34a52812008000414b3","546be36255639108002b184c"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-18T18:31:14.459Z","from_sync":false,"order":4,"slug":"open-graph","title":"Open Graph"},"user":"5433099f9a2b451a00ad4531","version":{"_id":"545137a814af501a00b50cfc","project":"545137a814af501a00b50cf9","__v":11,"createdAt":"2014-10-29T18:53:28.525Z","releaseDate":"2014-10-29T18:53:28.525Z","categories":["545137a814af501a00b50cfd","545138eaa66f020800dbab4a","546b9072b47b5d1400109edf","546b9082b47b5d1400109ee0","546b9088b47b5d1400109ee1","546b909462515a14007ebc43","546b90a0b47b5d1400109ee2","546ced235884600e007a92f6","5481008eea7fd40b00cd7c2b","573b9d83ee2b3b220042291f","57be1efa15efc70e006a5f99"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"githubsync":"","updates":["565dfad423fd5f0d00a1288a","56da7a1939d2460b0026bf9a"],"next":{"pages":[],"description":""},"createdAt":"2014-11-19T00:24:14.831Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"try":true,"basic_auth":false,"results":{"codes":[]},"settings":"","auth":"never","params":[],"url":""},"isReference":false,"order":2,"body":"**(Please note: 3rd Party Open Graph Activities are now deprecated as the activity ticker is deprecated. Refer to OGA Announcement Section)**\n\nThis is a detailed description of the activity schema and delivery.\n\n\n**Activity Envelope**\nAn activity envelope encapsulates the activity (actor, action and object) as well as an optional delivery list for the activity. It is a JSON object with the following fields:\n\n  * Actor (required) – A user object representing the Yammer user performing the activity.\n  \n  * Action (required) – The name of the action being performed.\n  \n  * Object (required) – An Open Graph (OG) object representing the object being acted upon by the actor.\n  \n  * Private (optional) – Boolean. Only show this activity and object to the targeted users. Defaults to false.\n  \n  * User message (optional) – 200 character text message describing this activity. Defaults to blank.\n  \n  * Users (optional) – An array of user objects to deliver the activity to.\n\n\n\n**User**\n\nEvery activity must specify a user as the actor. Activities can also include a set of user objects for delivery of the story. Users are defined by including:\n\n*Email (required) – User’s email address.\n\n*Name (optional) – User’s full name.\n\n\n\n**Object**\n\nEvery activity must specify exactly one OG object that has been acted upon. OG objects are uniquely identified by their URL in your app. In addition to including the URL of the object, the activity can contain attributes that more fully describe the object. We recommend setting as many of these attributes as you can for appropriate display in Yammer:\n\n  * Url (required) - Location of the Open Graph Object. This only works for publicly accessible content.\n  \n  * Title (required) – Title of the object as it should appear in stories.\n  \n  * Image (optional) – Thumbnail image that represents the object.\n  \n  * Description (optional) - A one to two sentence description of the object.\n\n\n\n**Supported Object Types**\n\nBy default the following object types are supported (see below). You can define custom object types by following the instructions in the “Custom Types” section [here](https://developer.yammer.com/docs/custom-types):\n\n- page (default)\n\n- place\n\n- person\n\n- department\n\n- team\n\n- project\n\n- folder\n\n- file\n\n- document\n\n- image\n\n- audio\n\n- video\n\n- company\n\n\n\n**Supported Actions**\n\nBy default the following actions are supported (see below). You can define custom actions by following the instructions in the “Custom Types” section [here](https://yammer.readme.io/docs/custom-types):\ncreate\n\nupdate\n\ndelete\n\nfollow\n\nlike\n\n\n\n**Delivering Activity** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP Method: POST\\nURL: https://www.yammer.com/api/v1/activity.json\\nAuthentication: OAuth 2 Access Token\\nRequest Content-Type: application/json\\nRequest Content Schema: { ActivityEnvelope } || [ { ActivityEnvelope } (, { ActivityEnvelope })* ]\\nExpected Response Code: 202 (Accepted)\\nExpected Response Body: None\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"schema","type":"basic","title":"Schema"}
**(Please note: 3rd Party Open Graph Activities are now deprecated as the activity ticker is deprecated. Refer to OGA Announcement Section)** This is a detailed description of the activity schema and delivery. **Activity Envelope** An activity envelope encapsulates the activity (actor, action and object) as well as an optional delivery list for the activity. It is a JSON object with the following fields: * Actor (required) – A user object representing the Yammer user performing the activity. * Action (required) – The name of the action being performed. * Object (required) – An Open Graph (OG) object representing the object being acted upon by the actor. * Private (optional) – Boolean. Only show this activity and object to the targeted users. Defaults to false. * User message (optional) – 200 character text message describing this activity. Defaults to blank. * Users (optional) – An array of user objects to deliver the activity to. **User** Every activity must specify a user as the actor. Activities can also include a set of user objects for delivery of the story. Users are defined by including: *Email (required) – User’s email address. *Name (optional) – User’s full name. **Object** Every activity must specify exactly one OG object that has been acted upon. OG objects are uniquely identified by their URL in your app. In addition to including the URL of the object, the activity can contain attributes that more fully describe the object. We recommend setting as many of these attributes as you can for appropriate display in Yammer: * Url (required) - Location of the Open Graph Object. This only works for publicly accessible content. * Title (required) – Title of the object as it should appear in stories. * Image (optional) – Thumbnail image that represents the object. * Description (optional) - A one to two sentence description of the object. **Supported Object Types** By default the following object types are supported (see below). You can define custom object types by following the instructions in the “Custom Types” section [here](https://developer.yammer.com/docs/custom-types): - page (default) - place - person - department - team - project - folder - file - document - image - audio - video - company **Supported Actions** By default the following actions are supported (see below). You can define custom actions by following the instructions in the “Custom Types” section [here](https://yammer.readme.io/docs/custom-types): create update delete follow like **Delivering Activity** [block:code] { "codes": [ { "code": "HTTP Method: POST\nURL: https://www.yammer.com/api/v1/activity.json\nAuthentication: OAuth 2 Access Token\nRequest Content-Type: application/json\nRequest Content Schema: { ActivityEnvelope } || [ { ActivityEnvelope } (, { ActivityEnvelope })* ]\nExpected Response Code: 202 (Accepted)\nExpected Response Body: None", "language": "text" } ] } [/block]