{"__v":1,"_id":"564b6355791099170071e9e8","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Welcome aboard, Rooster!\n\nYou are probably ready to get started send push notifications to your site's visitors - using the Roost API.  The following overview of the Roost API will help you get started quickly.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Customize Roost to Work for You\"\n}\n[/block]\nRoost is a push notification platform for websites. This API documentation provides instructions to perform both client-side and server-side integrations, so that you can customize your Roost notifications as needed.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Client-side Javascript\"\n}\n[/block]\n[Roost client-side APIs](doc:api-basics) are all **javascript**, which are invoked from inside your web pages.  This involves making calls to the Roost servers.  \n\nThe client-side API is typically used to do one of the following:\n\na) *show/hide the roost opt-in registration prompt*\nb) *to modify a particular user’s registration*\n\nBut only a small fraction of the Roost APIs are client-side.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<!-- JAVASCRIPT CLIENT-SIDE EXAMPLE\\nHere's an example of a Roost client-side call to segment your users. -->\\n<script>\\n    var _roost = _roost || [];\\n    _roost.push([\\\"segments\\\", \\\"breakingnews\\\", \\\"sports\\\"]);\\n</script>\\n<!-- The user that is active in this session is now assigned to the \\\"breakingnews\\\" and \\\"sports\\\" segments, which can be used to target messages to them later.\\\" -->\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Server-Side REST Services\"\n}\n[/block]\n[Roost server-side APIs](doc:rest-api-basics) are **[REST](http://en.wikipedia.org/wiki/Representational_state_transfer)** services which use **[JSON](http://en.wikipedia.org/wiki/JSON)** to transport parameters and return values. All services show **[curl](http://en.wikipedia.org/wiki/CURL)** examples, and examples for specific languages will be added as we have time to do them.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// REST API EXAMPLE\\n// This curl call is an example of a simple push.\\n// You would replace [api key] and [api secret]\\n// with the values from your Roost Settings tab\\n\\ncurl -X POST -u \\\"[api key]:[api secret]\\\" \\\\\\n  -H \\\"Content-Type: application/json\\\" \\\\\\n  --data '{\\\"alert\\\":\\\"This Message Title Converts Da Best\\\", \\\"url\\\":\\\"http://myfavoritesite.com/story123\\\"}' \\\\\\n  https://api.goroost.com/api/push \",\n      \"language\": \"text\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\nThere only a couple of requirements for using the Roost APIs.  Basically you need to have a Roost account, and you need the Roost Javascript installed on your site - which is the topic of our next section.","category":"564b6354791099170071e9e6","createdAt":"2015-11-17T17:26:45.417Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"564b6353791099170071e9e2","slug":"getting-started","sync_unique":"","title":"Roost API Basics","type":"basic","updates":[],"user":"54ed0ffea45a441700fd4cf0","version":"564b6353791099170071e9e5","childrenPages":[]}

Roost API Basics


Welcome aboard, Rooster! You are probably ready to get started send push notifications to your site's visitors - using the Roost API. The following overview of the Roost API will help you get started quickly. [block:api-header] { "type": "basic", "title": "Customize Roost to Work for You" } [/block] Roost is a push notification platform for websites. This API documentation provides instructions to perform both client-side and server-side integrations, so that you can customize your Roost notifications as needed. [block:api-header] { "type": "basic", "title": "Client-side Javascript" } [/block] [Roost client-side APIs](doc:api-basics) are all **javascript**, which are invoked from inside your web pages. This involves making calls to the Roost servers. The client-side API is typically used to do one of the following: a) *show/hide the roost opt-in registration prompt* b) *to modify a particular user’s registration* But only a small fraction of the Roost APIs are client-side. [block:code] { "codes": [ { "code": "<!-- JAVASCRIPT CLIENT-SIDE EXAMPLE\nHere's an example of a Roost client-side call to segment your users. -->\n<script>\n var _roost = _roost || [];\n _roost.push([\"segments\", \"breakingnews\", \"sports\"]);\n</script>\n<!-- The user that is active in this session is now assigned to the \"breakingnews\" and \"sports\" segments, which can be used to target messages to them later.\" -->", "language": "javascript" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Server-Side REST Services" } [/block] [Roost server-side APIs](doc:rest-api-basics) are **[REST](http://en.wikipedia.org/wiki/Representational_state_transfer)** services which use **[JSON](http://en.wikipedia.org/wiki/JSON)** to transport parameters and return values. All services show **[curl](http://en.wikipedia.org/wiki/CURL)** examples, and examples for specific languages will be added as we have time to do them. [block:code] { "codes": [ { "code": "// REST API EXAMPLE\n// This curl call is an example of a simple push.\n// You would replace [api key] and [api secret]\n// with the values from your Roost Settings tab\n\ncurl -X POST -u \"[api key]:[api secret]\" \\\n -H \"Content-Type: application/json\" \\\n --data '{\"alert\":\"This Message Title Converts Da Best\", \"url\":\"http://myfavoritesite.com/story123\"}' \\\n https://api.goroost.com/api/push ", "language": "text" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Getting Started" } [/block] There only a couple of requirements for using the Roost APIs. Basically you need to have a Roost account, and you need the Roost Javascript installed on your site - which is the topic of our next section.
Welcome aboard, Rooster! You are probably ready to get started send push notifications to your site's visitors - using the Roost API. The following overview of the Roost API will help you get started quickly. [block:api-header] { "type": "basic", "title": "Customize Roost to Work for You" } [/block] Roost is a push notification platform for websites. This API documentation provides instructions to perform both client-side and server-side integrations, so that you can customize your Roost notifications as needed. [block:api-header] { "type": "basic", "title": "Client-side Javascript" } [/block] [Roost client-side APIs](doc:api-basics) are all **javascript**, which are invoked from inside your web pages. This involves making calls to the Roost servers. The client-side API is typically used to do one of the following: a) *show/hide the roost opt-in registration prompt* b) *to modify a particular user’s registration* But only a small fraction of the Roost APIs are client-side. [block:code] { "codes": [ { "code": "<!-- JAVASCRIPT CLIENT-SIDE EXAMPLE\nHere's an example of a Roost client-side call to segment your users. -->\n<script>\n var _roost = _roost || [];\n _roost.push([\"segments\", \"breakingnews\", \"sports\"]);\n</script>\n<!-- The user that is active in this session is now assigned to the \"breakingnews\" and \"sports\" segments, which can be used to target messages to them later.\" -->", "language": "javascript" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Server-Side REST Services" } [/block] [Roost server-side APIs](doc:rest-api-basics) are **[REST](http://en.wikipedia.org/wiki/Representational_state_transfer)** services which use **[JSON](http://en.wikipedia.org/wiki/JSON)** to transport parameters and return values. All services show **[curl](http://en.wikipedia.org/wiki/CURL)** examples, and examples for specific languages will be added as we have time to do them. [block:code] { "codes": [ { "code": "// REST API EXAMPLE\n// This curl call is an example of a simple push.\n// You would replace [api key] and [api secret]\n// with the values from your Roost Settings tab\n\ncurl -X POST -u \"[api key]:[api secret]\" \\\n -H \"Content-Type: application/json\" \\\n --data '{\"alert\":\"This Message Title Converts Da Best\", \"url\":\"http://myfavoritesite.com/story123\"}' \\\n https://api.goroost.com/api/push ", "language": "text" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Getting Started" } [/block] There only a couple of requirements for using the Roost APIs. Basically you need to have a Roost account, and you need the Roost Javascript installed on your site - which is the topic of our next section.
{"__v":1,"_id":"5650aeeb25691837008a7fad","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Roost currently supports web push in the following browsers:\n\n**Safari** \n[block:html]\n{\n  \"html\": \"<ul>\\n  <li>Safari on Mac OS X (10.9+)</li>\\n</ul>\"\n}\n[/block]\n**Chrome** \n[block:html]\n{\n  \"html\": \"<ul>\\n  <li>Chrome on Mac OS X</li>\\n  <li>Chrome on Windows</li>\\n  <li>Chrome on Linux</li>\\n  <li>Chrome on Android</li>\\n</ul>\"\n}\n[/block]\n**Firefox**\n[block:html]\n{\n  \"html\": \"<ul>\\n  <li>Firefox on Mac OS X</li>\\n  <li>Firefox on Windows</li>\\n  <li>Firefox on Linux</li>\\n  <li>Firefox on Android - coming soon</li>\\n</ul>\"\n}\n[/block]","category":"5650ae38a462732b002b3650","createdAt":"2015-11-21T17:50:35.195Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":999,"project":"564b6353791099170071e9e2","slug":"roost-supported-browsers","sync_unique":"","title":"Roost-Supported Browsers","type":"basic","updates":[],"user":"54ed0ffea45a441700fd4cf0","version":"564b6353791099170071e9e5","childrenPages":[]}

Roost-Supported Browsers


Roost currently supports web push in the following browsers: **Safari** [block:html] { "html": "<ul>\n <li>Safari on Mac OS X (10.9+)</li>\n</ul>" } [/block] **Chrome** [block:html] { "html": "<ul>\n <li>Chrome on Mac OS X</li>\n <li>Chrome on Windows</li>\n <li>Chrome on Linux</li>\n <li>Chrome on Android</li>\n</ul>" } [/block] **Firefox** [block:html] { "html": "<ul>\n <li>Firefox on Mac OS X</li>\n <li>Firefox on Windows</li>\n <li>Firefox on Linux</li>\n <li>Firefox on Android - coming soon</li>\n</ul>" } [/block]
Roost currently supports web push in the following browsers: **Safari** [block:html] { "html": "<ul>\n <li>Safari on Mac OS X (10.9+)</li>\n</ul>" } [/block] **Chrome** [block:html] { "html": "<ul>\n <li>Chrome on Mac OS X</li>\n <li>Chrome on Windows</li>\n <li>Chrome on Linux</li>\n <li>Chrome on Android</li>\n</ul>" } [/block] **Firefox** [block:html] { "html": "<ul>\n <li>Firefox on Mac OS X</li>\n <li>Firefox on Windows</li>\n <li>Firefox on Linux</li>\n <li>Firefox on Android - coming soon</li>\n</ul>" } [/block]