Simple Push Notifications
So now you're ready to send a notification and get your content in front of your subscribers! We can do this with a single API call, assuming you've created a segment of subscribers (or are sending to less than 100 subscribers), and you've already uploaded your content.
Simplest way to push a notification
Note: Click here to view a list of subscribers belonging to your Pushologies account.
If you just want to push to 100 or less subscribers and are hosting your content yourself, you only need the one API call with this example POST body:
POST /v1/push
{
"pushMessage": {
"title": "<Title of the notification>",
"contentUrl": "<url to video file>",
"bannerImageContentUrl": "<optional url to a banner image>",
"message": "<Your message here>",
"type": "VIDEO"
},
"targetSegment": {
"subscriberIds": [
"<subscriber id 1>",
"<subscriber id 2",
// ...
"<subscriber id 100>"
]
},
"notificationSchedule": {
"now": true
}
}
Pushing a notification with existing Content Item and Segment
Alternatively, if you've created a segment and uploaded some content, you can now push the notification:
POST /v1/push
{
"pushMessage": {
"title": "<Title of the notification>",
"contentId": "<video content item id>",
"bannerImageContentId": "<optional banner content item id",
"message": "<Your message here>",
"type": "VIDEO"
},
"targetSegment": {
"segmentId": "<id of segment we created>"
},
"notificationSchedule": {
"now": true
}
}
What next?
Obviously the above only gives a couple of very simple examples to get you up and running with the basics. The main notification types are explained here. We also encourage you to explore the API further and feel free to ask questions if you need more help, examples or support.
Updated over 3 years ago