Using Postman

How to use postman for Server REST API testing

You can use Postman to work with our REST API. Follow the screenshots below to see how to use Postman for our Create notification API endpoint.

Create notification

This example will explain how to target a single or multiple OneSignal Apps.

For multiple apps, make sure to checkout how to use Postman's Collections to send to all apps at once. Be careful when testing not to spam all users on all apps!

Select New Collection (name the collection) > Click Add request (name the request)

325325

1. Select POST

add:
https://onesignal.com/api/v1/notifications

2. Create the Headers

Line 1 key: Authorization value: Basic ONESIGNAL_REST_API_KEY

  • Replace ONESIGNAL_REST_API_KEY with the value found in Keys & IDs
  • If targeting multiple Apps, set: Basic {{REST_API_KEY}} to device the Variable REST_API_KEY

Line 2 key: Content-Type value: application/json
You MUST use this value with postman for our API.

685685

3. Add the Body

select raw
add your JSON

See the Create notification API docs for all parameters.

If targeting multiple Apps, set the {{appId}} and {{url}} variables along with any other variables you would like. Otherwise all apps will get the same data.

10851085

4. Save and Send

Click the "Save" button to reuse this request multiple times.

You can now press the "Send" button to send to everyone in the "Subscribed Users" segment defined in the above example or replace with the Segments you want to include.

If targeting multiple Apps, create a .csv file with at least 3 columns: REST_API_KEY, appId, and url (as shown in the above example). Any other variable data will need to be added to the .csv file as well. You can find the App ID and Rest API Key within Keys & IDs or use the View apps API endpoint.

Example:

771771

Once you have the CSV data of your variable values, in Postman, select the Collections Arrow and click Run

697697

Next to "Data" click Select File, upload the .csv file with all the variables.

Next to "Delay" add 30000 ms.

POINT OF SENDING once you click Run Create ... it will start to send the push.

484484

View Notifications

1. Select GET

add:
https://onesignal.com/api/v1/notifications?app_id=YOUR_APP_ID&limit=:limit&offset=:offset&kind=:kind

2. Set Params

Under the VALUE Column put the following data you want to collect.

KeyValue
app_idYour OneSignal App Id to get the notifications from
limitHow many notifications you want.
Default: 50
Max: 50
Minimum: 1
offsetPage offset ie How many notifications to skip over. If you got 50 notifications in the last call. You can offset by 50 to get the next 50 notifications.
kindThe kind of notifications you want.
Default: blank - all kinds of notifications
0 - Dashboard Sent Notifications
1 - REST API Sent Notifications
3 - Automated Messages.
22162216

3. Set Headers

For the KEY set Authorization and VALUE set Basic YOUR_REST_API_KEY where YOUR_REST API_KEY can be found in Keys & IDs.

21922192

4. Press Send

You will get the results similar to here: https://documentation.onesignal.com/reference#section-result-format-view-notifications


View Apps

OneSignal has an API for viewing all your apps or only specific apps you want.

In this quick example, we will look at viewing all app data.

1. Setup GET Url

In the Postman interface, select the GET call and add the url: https://onesignal.com/api/v1/apps

18201820

2. Add User Auth Key

This call Requires your OneSignal User Auth Key, (not REST API Key) which is available in Keys & IDs.

In Postman under Headers use the Authorization key and for value use: Basic YOUR_USER_AUTH_KEY Make sure to put your User Auth key.

10921092

3. Send and Save

Once you do that, you can click Send on Postman to get all your app data.

Common important data would be:

"id"OneSignal App Id
"players"Total Users
"messageable_players"Subscribers

Don't forget to press Save to keep this call for later.

CSV User Export

1. Download Postman (if you have not done so already).

You can download postman here: https://www.getpostman.com/

2. Create Collection

Open Postman and Select Collections > + New Collection

25962596

Name the collection "CSV User Export" and click "Create"

25962596

3. Create the Request

Select the collection and click "Add request"

740740

Name the Request "CSV User Export" and "Save to CSV User Export"

10561056

Select the Request in the Collection

25082508

Now that this is created, you can re-use it as much as you like.

4. Setup the Request

1 - Select POST
2 - Past this url https://onesignal.com/api/v1/players/csv_export?app_id=

16761676

3 - Select Headers
4 - Add Authorization and Content-Type keys
5 - Next to Authorization set Basic YOUR_REST_API_KEY replace with your actual REST API Key
6 - Next to "Content-Type" add application/json

16841684

Optional Add Extra Data - use this if you need the p256, web_auth, country, location and/or ip address.

7 - Select Body
8 - Select raw
9 - add this json

{"extra_fields": ["country","location","notification_types","ip", "external_user_id", "web_auth", "web_p256"]}
16861686

5. Make the request and open the file

Click "Send" and copy-paste the provided URL into a browser.

The URL you need to put in the browser will look like this:
https://onesignal.s3.amazonaws.com/csv_exports/3beb3078-e0f1-4629-af17-fde833b9f716/users_59891cdc338b8b5eb128438512a60b83_2020-01-22.csv.gz

16881688

When you add this URL To the browser, you might see this page:

12701270

This means the data is loading, please wait 10 to 20 minutes (depending on how big the app is) and refresh the page, eventually this will download the list.


What’s Next