Push to All

This API can be used to send notifications to all subscribers for your website

Definition

curl -X POST \
 - H "Authentication-Token: {API_TOKEN}" \
 - H "Content-Type: application/json" \
 -d '{
 "title" : "{NOTIFICATION_TITLE}",
 "message" : "{NOTIFICATION_MESSAGE}",
 "icon_url" : "{ICON_URL}",
 "banner_url" : "{BANNER_URL}",
 "landing_url" : "{LANDING_URL}",
 "actions" : [
 {
 "text" : "{BUTTON1_TEXT}",
 "url" : "{BUTTON1_URL}"
 },
 {
 "text" : "{BUTTON2_TEXT}",
 "url" : "{BUTTON2_URL}"
 }],
 "utm_source" : "{UTM_SOURCE}",
 "utm_medium" : "{UTM_MEDIUM}",
 "utm_campaign" : "{UTM_CAMPAIGN}",
 "ttl" : "{TTL_SECONDS}",
 "target" : {
 "type" : "all"
 }
 }' "https://apis.izooto.com/v1/notifications"

Parameters

Name
Description
Type
Required
Supported On

Authentication-token

API token for your site

String

Yes

-

Campaign Name

Campaign Title

String

Yes

Chrome,
Firefox,
Safari,
Opera,
Edge

Titile

Notification Title

String

Yes

Chrome,
Firefox,
Safari,
Opera,
Edge

Message

Message on Notification

String

Yes

Chrome,
Firefox,
Safari,
Opera,
Edge

Icon Upload

File Size >= 20kb
(Dimensions: 100 X 100)

Jpg, Jpeg, Png formats only

Yes

Chrome 50+,
Firefox 44+,
Opera 42+,
Edge 17+
Note: Safari uses a default bell Icon

icon_url

Notification icon URL
(HTTPS URL Only)
(Dimensions: 100 X 100)

String

Yes

Chrome 50+,
Firefox 44+,
Opera 42+,
Edge 17+

Banner Upload

File Size>=100Kb
(Dimensions: 360 X 240 for Desktop and 360 X 200 for Mobile)

Jpg, Jpeg, Png formats only

No

Chrome 56+,
Opera 57+,
Edge 17+

banner_url

URL of banner image
(HTTPS)
(Dimensions: 360 X 240 for Desktop and 360 X 200 for Mobile)

String

No

Chrome 56+,
Opera 57+,
Edge 17+

landing_url

Landing Page URL

String

Yes

Chrome,
Firefox,
Safari,
Opera,
Edge

actions > text

Button Text

String

No

Chrome 56+,
Opera 57+,
Edge 17+

actions > url

Button Landing URL

String

No

Chrome 56+,
Opera 57+,
Edge 17+

utm_source

UTM Source

String

No

Chrome,
Firefox,
Safari,
Opera,
Edge

utm_medium

UTM Medium

String

No

Chrome,
Firefox,
Safari,
Opera,
Edge

utm_campaign

UTM Campaign

String

No

Chrome,
Firefox,
Safari,
Opera,
Edge

ttl (time-to -live)

Notification expiry time

Numeric (seconds)

No

Chrome,
Firefox,
Opera

Sample Code

curl -X POST \        
 - H "Authentication-Token: abc123efgh456ijklmn9786" \
 - H "Content-Type: application/json" \
 -d '{
 "title" : "Limited Period Offer",
 "message" : "Go Shopping, Save Big",
 "icon_url" : "https://yourdomain.com/icon.png",
 "banner_url" : "https://yourdomain.com/large-image.png",
 "landing_url" : "https://yourdomain.com/offers",
 "actions" : [
 {
 "text" : "Buy Now",
 "url" : "https://yourdomain.com/buy-now"
 },
 {
 "text" : "Compare",
 "url" : "https://yourdomain.com/compare"
 }],
 "utm_source" : "izooto",
 "utm_medium" : "push_notification",
 "utm_campaign" : "promotion",
 "ttl" : "86400",
 "target" : {
 "type" : "all"
 }
 }' "https://apis.izooto.com/v1/notifications"

Push to All


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.