{"__v":15,"_id":"55af5a24826d210d00041e4b","category":{"__v":1,"_id":"55af586d555b900d0036d296","project":"5540ce1b31827a0d007ab1cc","version":"5540ce1c31827a0d007ab1cf","pages":["55af5a24826d210d00041e4b"],"reference":false,"createdAt":"2015-07-22T08:46:37.620Z","from_sync":false,"order":0,"slug":"send-push-guide","title":"Send Push Guide"},"project":"5540ce1b31827a0d007ab1cc","user":"55a79a4d4a33f92b00b7a111","version":{"__v":27,"_id":"5540ce1c31827a0d007ab1cf","project":"5540ce1b31827a0d007ab1cc","createdAt":"2015-04-29T12:27:08.390Z","releaseDate":"2015-04-29T12:27:08.390Z","categories":["5540ce1c31827a0d007ab1d0","5540d91bbb9e762d00f594ad","5540e5f131827a0d007ab212","5540e5febb9e762d00f594d3","5540e61331827a0d007ab213","5540e6195cf9682100d61afa","5540e62631827a0d007ab214","5540e63031827a0d007ab215","5540e63531827a0d007ab216","5540e63e5cf9682100d61afc","5540e6445cf9682100d61afd","5540e64a5cf9682100d61afe","55a4ff5b2e70c0250038050f","55acb28318eefd0d0071d504","55ae1abe8576b92300291c80","55ae453ef302af23000ac109","55af586d555b900d0036d296","55af91dac8a85321007a53c3","55b9fee204775a2f00628071","55b9ff0e04775a2f00628072","55b9ff4604775a2f00628073","55b9ff5fd72d1e1900276a38","55b9ff7f04775a2f00628074","55b9ff90eb08801900f833e5","55b9ffa5d72d1e1900276a39","55b9ffca04775a2f00628075","55b9fffdd72d1e1900276a3a"],"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"createdAt":"2015-07-22T08:53:56.088Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"order":0,"body":"First of all, login into your [Pushwoosh Control Panel](https://cp.pushwoosh.com/) and click on the application you would like to send push to.\n\nWe have separated all our features into two sets of tabs – the first set of tabs is applicable to all platforms, and consists of the General, Scheduling, Additional Data and Filters tabs.\n\nThe second group of tabs is platform-specific, and allows you to customize your notifications for each platform.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"General tab\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/lAN0j5BS7a1z7v8l7RoV\",\n        \"sendpush1.png\",\n        \"1183\",\n        \"674\",\n        \"#085c8d\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Sending multi-language notifications:**\n\nWith Multi-language feature you can create push notifications in different languages with one click, and they will be delivered depending on device locale settings. Talk to your users in their language!\n\nLanguage tabs are intended to compose language-specific pushes to devices with corresponding locale settings. The default language in Pushwoosh is English; **if no content for English is specified, Pushwoosh randomly chooses the language** as a default from those that are set.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"For example, if you input a message only for English (“en” tab), all other language subscribers will receive the content in English, as it is a default language. If you input the message only for “nl” and “fr”, the message will be send to all devices, but English and Turkish subscribers will receive a randomly chosen message – intended either for “nl” or “fr”, since “en” is empty.\"\n}\n[/block]\nIn order to **send language-specific pushes to language-specific devices only**, you should apply Language filters to them. Please refer to Filters tab paragraph below.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Scheduling tab\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/1PnZL02eRKWiuDuMwAt0\",\n        \"sendpush2.png\",\n        \"1190\",\n        \"675\",\n        \"#085b8b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nUse Scheduling tab to set time you want your notifications to be sent. By default, all notifications are set to be “sent now”, right after you press **Woosh!**\n\nIf you would like to send notifications at a certain time, choose “Send on” and pick the time and date; scheduling date limit is set to one month.\n\nAnother sufficient scheduling feature is “Send according to users’s timezone”. Set the toggle to ON, and your users will be notified at the time you set. Please note that in this case the push status (https://cp.pushwoosh.com/notifications) will be changing from pending to processing back and forth for 24 hours, until all timezones are covered.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you send the push according to user’s timezone, and the date & time you specified has already passed in some timezones, *the push will be sent to these timezones immediately.* All other timezones will receive the push according to their local time.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Additional Data tab\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/IPNSqMWVSRyqiLIHlM2g\",\n        \"sendpush3.png\",\n        \"1183\",\n        \"671\",\n        \"#085c8d\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**URL:** You can send a URL along with a push notification. When a user opens this notification, the application will be launched first, and then the URL will be opened in a default browser, for example, Safari on iOS.\n\n**Rich HTML Page:** Choose one of the rich media pages you have created in the Rich Pages section. These pages are opened in a webview of your application, once a user opens notification. Thus, when a user is done viewing this page, he or she comes back to your application.\n\n**Custom data:** you can pass any additional JSON data in a {“key”:”value”} format, which you may use for deep linking.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Filters tab\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/5VlUU5SKTJyODLIQjBi5\",\n        \"sendpush4.png\",\n        \"1187\",\n        \"676\",\n        \"#0a5b8b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nIn this tab you can apply a filter which you should create in the Filters section first.\n\nUse filters if you would like to send push to a specific group of devices only.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"For example, in order to send push to devices with **French locale only**, you have to create a #Language(fr) filter first, and apply this filter to your push. Thus, the message will be sent only to devices subscribed with the French language.\"\n}\n[/block]\nIf you do not wish to use a chosen filter, click the “Clear filter” button.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"PLATFORM SPECIFIC TABS\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"iOS\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/Y0GSekY6RuWnqpt0ufSg\",\n        \"spios.png\",\n        \"1187\",\n        \"669\",\n        \"#1b82ae\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Badges:** an iOS badge number you would like to send with your push. Use +n / -n to increment / decrement the current badge value. Sending 0 clears the badge from your app’s icon.\n\n**Sound:** here you can specify the name of a custom sound file in the main bundle of your application.\n\n**iOS8 Category:** select a Category with the set of buttons for iOS8.\n\n**iOS Root Params:** Root level parameters to the APS dictionary.\n\nCheck **Send silent notification** if you need to send a silent push with `content-available` property. When a silent push arrives, iOS wakes up your app in the background so that you can get new data from your server or do background information processing.\n\nCheck **Newsstand notification** to send push to your iOS newsstand application.\n\n**Expiration time:** set the period after which the push won't be delivered if the device was offline.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Android\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/KF1CG8nNQFGg11Q1xy8u\",\n        \"spandro.png\",\n        \"1188\",\n        \"809\",\n        \"#09405f\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Header:** You can specify your Android notification header here.\n\n**Sound:** Here you can specify the name of a custom sound file in the “res/raw” folder of your application, without the file extension.\n\n**LED:** choose LED color, the device will do its best approximation.\n\n**Force Vibration:** vibrate on arrival, use for urgent messages only.\n\n**Icon:** Enter the path to the notification icon.\n\n**Banner:** enter image URL here. Image must be =< 450px wide, ~2:1 aspect, and it will be centerCropped.\n\n**Android root params:** root level parameters for the Android payload, custom key-value object.\n\n**Expiration time:** set the period after which the push won't be delivered if the device was offline.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"BlackBerry\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/DP8gF38eRFuSlrDUqkKm\",\n        \"spbb.png\",\n        \"1188\",\n        \"716\",\n        \"#15648f\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Header:** You can specify your BlackBerry notification header here.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Windows Phone\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/g18ZctLFTn2CVFTEecDN\",\n        \"spwp.png\",\n        \"1190\",\n        \"713\",\n        \"#1f86c5\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nFirst of all, **choose the Windows Phone notification type – toast or tile.** You can customize your Tile type push by adding the following parameters:\n\n**Count:** The number displayed on the front side of the tile.\n\n**Front background image:** Enter full path to the image to be used as a background for the front side of the tile.\n\n**Back content:** Single line of text in the top of the back side of the tile.\n\n**Back background image:** Enter full path to the image to be used as a background for the back side of the tile.\n\n**Back title:** Single line of text in the bottom of the back side of the title.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Windows 8\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/gDpMh9fdQuIJPUc6jfCz\",\n        \"spwin8.png\",\n        \"1186\",\n        \"700\",\n        \"#1886ae\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nSince Windows 8 provides over 60 toast, tile, raw and badge templates, we added only toast templates to the GUI, since they are used more then the others. Tile, raw and badge templates are available via Remote API only.\n\n**The first step is to choose the template from the list on the right** to unlock corresponding inputs. Then you can input content for all languages you need. Due to the multiple number of fields in Windows 8 push templates, we had to separate it from all other platforms. It has its very own set of language tabs, which you should use the same way as universal language tabs.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Amazon\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/gqtqVlkQTl6gVr4xevXZ\",\n        \"spamazon.png\",\n        \"1187\",\n        \"660\",\n        \"#067dc5\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Header:** You can specify your Amazon notification header here.\n\n**Sound:** Here you can specify the name of a custom sound file in the “res/raw” folder of your application, without the file extension.\n\n**Icon:** Enter the path to the notification icon.\n\n**Banner:** enter the full path to the notification banner.\n\n**Expiration time:** set the period after which the push won't be delivered if the device was offline.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Safari\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/Drbf6efRtC26PGRY0w2w\",\n        \"spsafari.png\",\n        \"1187\",\n        \"692\",\n        \"#227791\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Title:** Specify your Safari notification title here. This is field is required, otherwise the push will not be delivered to your users.\n\n**Action button label (optional):** Specify the custom action button label here. If not set, “Show” will be displayed as a default.\n\n**URL field:** Type in the part of the URL instead of a placeholder you specified in the app’s Safari configuration. A user will be redirected to this URL in Safari upon opening your notification.\n\n**Expiration time:** set the period after which the push won't be delivered if the device was offline.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Chrome\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://www.filepicker.io/api/file/nttqNBnTBmKfPyeqQXR6\",\n        \"spchrome.png\",\n        \"1187\",\n        \"475\",\n        \"#137ab9\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Icon:** Specify the icon name in the resources of your extension, or the full path URL\n\n**Title:** Specify your Chrome notification title. \n\n**Expiration time:** set the period after which the push won't be delivered if the device was offline.\n\nThat’s it! Easy, isn’t it?","excerpt":"This tutorial demonstrates how to use Send Push form to send push notifications.","slug":"send-push","type":"basic","title":"Send Push"}

Send Push

This tutorial demonstrates how to use Send Push form to send push notifications.

First of all, login into your [Pushwoosh Control Panel](https://cp.pushwoosh.com/) and click on the application you would like to send push to. We have separated all our features into two sets of tabs – the first set of tabs is applicable to all platforms, and consists of the General, Scheduling, Additional Data and Filters tabs. The second group of tabs is platform-specific, and allows you to customize your notifications for each platform. [block:api-header] { "type": "basic", "title": "General tab" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/lAN0j5BS7a1z7v8l7RoV", "sendpush1.png", "1183", "674", "#085c8d", "" ] } ] } [/block] **Sending multi-language notifications:** With Multi-language feature you can create push notifications in different languages with one click, and they will be delivered depending on device locale settings. Talk to your users in their language! Language tabs are intended to compose language-specific pushes to devices with corresponding locale settings. The default language in Pushwoosh is English; **if no content for English is specified, Pushwoosh randomly chooses the language** as a default from those that are set. [block:callout] { "type": "info", "body": "For example, if you input a message only for English (“en” tab), all other language subscribers will receive the content in English, as it is a default language. If you input the message only for “nl” and “fr”, the message will be send to all devices, but English and Turkish subscribers will receive a randomly chosen message – intended either for “nl” or “fr”, since “en” is empty." } [/block] In order to **send language-specific pushes to language-specific devices only**, you should apply Language filters to them. Please refer to Filters tab paragraph below. [block:api-header] { "type": "basic", "title": "Scheduling tab" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/1PnZL02eRKWiuDuMwAt0", "sendpush2.png", "1190", "675", "#085b8b", "" ] } ] } [/block] Use Scheduling tab to set time you want your notifications to be sent. By default, all notifications are set to be “sent now”, right after you press **Woosh!** If you would like to send notifications at a certain time, choose “Send on” and pick the time and date; scheduling date limit is set to one month. Another sufficient scheduling feature is “Send according to users’s timezone”. Set the toggle to ON, and your users will be notified at the time you set. Please note that in this case the push status (https://cp.pushwoosh.com/notifications) will be changing from pending to processing back and forth for 24 hours, until all timezones are covered. [block:callout] { "type": "info", "body": "If you send the push according to user’s timezone, and the date & time you specified has already passed in some timezones, *the push will be sent to these timezones immediately.* All other timezones will receive the push according to their local time." } [/block] [block:api-header] { "type": "basic", "title": "Additional Data tab" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/IPNSqMWVSRyqiLIHlM2g", "sendpush3.png", "1183", "671", "#085c8d", "" ] } ] } [/block] **URL:** You can send a URL along with a push notification. When a user opens this notification, the application will be launched first, and then the URL will be opened in a default browser, for example, Safari on iOS. **Rich HTML Page:** Choose one of the rich media pages you have created in the Rich Pages section. These pages are opened in a webview of your application, once a user opens notification. Thus, when a user is done viewing this page, he or she comes back to your application. **Custom data:** you can pass any additional JSON data in a {“key”:”value”} format, which you may use for deep linking. [block:api-header] { "type": "basic", "title": "Filters tab" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/5VlUU5SKTJyODLIQjBi5", "sendpush4.png", "1187", "676", "#0a5b8b", "" ] } ] } [/block] In this tab you can apply a filter which you should create in the Filters section first. Use filters if you would like to send push to a specific group of devices only. [block:callout] { "type": "info", "body": "For example, in order to send push to devices with **French locale only**, you have to create a #Language(fr) filter first, and apply this filter to your push. Thus, the message will be sent only to devices subscribed with the French language." } [/block] If you do not wish to use a chosen filter, click the “Clear filter” button. [block:api-header] { "type": "basic", "title": "PLATFORM SPECIFIC TABS" } [/block] [block:api-header] { "type": "basic", "title": "iOS" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/Y0GSekY6RuWnqpt0ufSg", "spios.png", "1187", "669", "#1b82ae", "" ] } ] } [/block] **Badges:** an iOS badge number you would like to send with your push. Use +n / -n to increment / decrement the current badge value. Sending 0 clears the badge from your app’s icon. **Sound:** here you can specify the name of a custom sound file in the main bundle of your application. **iOS8 Category:** select a Category with the set of buttons for iOS8. **iOS Root Params:** Root level parameters to the APS dictionary. Check **Send silent notification** if you need to send a silent push with `content-available` property. When a silent push arrives, iOS wakes up your app in the background so that you can get new data from your server or do background information processing. Check **Newsstand notification** to send push to your iOS newsstand application. **Expiration time:** set the period after which the push won't be delivered if the device was offline. [block:api-header] { "type": "basic", "title": "Android" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/KF1CG8nNQFGg11Q1xy8u", "spandro.png", "1188", "809", "#09405f", "" ] } ] } [/block] **Header:** You can specify your Android notification header here. **Sound:** Here you can specify the name of a custom sound file in the “res/raw” folder of your application, without the file extension. **LED:** choose LED color, the device will do its best approximation. **Force Vibration:** vibrate on arrival, use for urgent messages only. **Icon:** Enter the path to the notification icon. **Banner:** enter image URL here. Image must be =< 450px wide, ~2:1 aspect, and it will be centerCropped. **Android root params:** root level parameters for the Android payload, custom key-value object. **Expiration time:** set the period after which the push won't be delivered if the device was offline. [block:api-header] { "type": "basic", "title": "BlackBerry" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/DP8gF38eRFuSlrDUqkKm", "spbb.png", "1188", "716", "#15648f", "" ] } ] } [/block] **Header:** You can specify your BlackBerry notification header here. [block:api-header] { "type": "basic", "title": "Windows Phone" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/g18ZctLFTn2CVFTEecDN", "spwp.png", "1190", "713", "#1f86c5", "" ] } ] } [/block] First of all, **choose the Windows Phone notification type – toast or tile.** You can customize your Tile type push by adding the following parameters: **Count:** The number displayed on the front side of the tile. **Front background image:** Enter full path to the image to be used as a background for the front side of the tile. **Back content:** Single line of text in the top of the back side of the tile. **Back background image:** Enter full path to the image to be used as a background for the back side of the tile. **Back title:** Single line of text in the bottom of the back side of the title. [block:api-header] { "type": "basic", "title": "Windows 8" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/gDpMh9fdQuIJPUc6jfCz", "spwin8.png", "1186", "700", "#1886ae", "" ] } ] } [/block] Since Windows 8 provides over 60 toast, tile, raw and badge templates, we added only toast templates to the GUI, since they are used more then the others. Tile, raw and badge templates are available via Remote API only. **The first step is to choose the template from the list on the right** to unlock corresponding inputs. Then you can input content for all languages you need. Due to the multiple number of fields in Windows 8 push templates, we had to separate it from all other platforms. It has its very own set of language tabs, which you should use the same way as universal language tabs. [block:api-header] { "type": "basic", "title": "Amazon" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/gqtqVlkQTl6gVr4xevXZ", "spamazon.png", "1187", "660", "#067dc5", "" ] } ] } [/block] **Header:** You can specify your Amazon notification header here. **Sound:** Here you can specify the name of a custom sound file in the “res/raw” folder of your application, without the file extension. **Icon:** Enter the path to the notification icon. **Banner:** enter the full path to the notification banner. **Expiration time:** set the period after which the push won't be delivered if the device was offline. [block:api-header] { "type": "basic", "title": "Safari" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/Drbf6efRtC26PGRY0w2w", "spsafari.png", "1187", "692", "#227791", "" ] } ] } [/block] **Title:** Specify your Safari notification title here. This is field is required, otherwise the push will not be delivered to your users. **Action button label (optional):** Specify the custom action button label here. If not set, “Show” will be displayed as a default. **URL field:** Type in the part of the URL instead of a placeholder you specified in the app’s Safari configuration. A user will be redirected to this URL in Safari upon opening your notification. **Expiration time:** set the period after which the push won't be delivered if the device was offline. [block:api-header] { "type": "basic", "title": "Chrome" } [/block] [block:image] { "images": [ { "image": [ "https://www.filepicker.io/api/file/nttqNBnTBmKfPyeqQXR6", "spchrome.png", "1187", "475", "#137ab9", "" ] } ] } [/block] **Icon:** Specify the icon name in the resources of your extension, or the full path URL **Title:** Specify your Chrome notification title. **Expiration time:** set the period after which the push won't be delivered if the device was offline. That’s it! Easy, isn’t it?