Push Notifications
PUSH NOTIFICATIONS API
NotifyVisitors API endpoints enable you to send push notifications to the users to nudge them to perform an action on your site. You can send the notifications to all the subscribers, or a specific user, or any segment.
You can call on the below API to send push notifications to the users.
API ENDPOINTS FOR DIFFERENT PLATFORMS
NotifyVisitors provides different API Endpoints for different platforms :
Web
- Send push notifications to the users anywhere and anytime using different API endpoints across the web platforms and devices.
https://push.notifyvisitors.com/api/v1/web/
Android
- Send push notifications to the users via API endpoints on their android devices.
https://push.notifyvisitors.com/api/v1/android/
IOS
- Send notifications to the users via API endpoints on ios devices provided by NV.
https://push.notifyvisitors.com/api/v1/ios/
Note:
You can send the push notifications on all these platforms to an individual, to a particular segment, or to all the subscribers.
API ENDPOINTS FOR DIFFERENT SEGMENTS
To Individual User
- You can send notifications to the individual subscribers on the basis of their subscriber ID or User ID via the below API endpoint
https://push.notifyvisitors.com/api/v1/web/send
You have to send the post parameters such as title, message, URL of the notification of an individual subscriber to an API endpoint. Read below for more information.
To All The Subscribers
- Call the below API endpoint to send notifications to all the subscribers.
https://push.notifyvisitors.com/api/v1/android/broadcast/all
The title, message, URL of the notification, and image have to be sent as the post parameters to the API endpoint.
To A Particular Segment
- Call the below API endpoint to send notifications to subscribers of a particular
segment.
https://push.notifyvisitors.com/api/v1/web/broadcast/segment
Title message, URL of the notification have to be sent as the post parameters to the API endpoint.
Pass the Parameter in Request Body
See the below example
curl --request POST \
--url https://push.notifyvisitors.com/api/v1/web/send \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'x-brand-id: YOUR_BRAND_ID'\
--data '{"user_id / subscription_id":"1234",
"notification_id":3456,
"title":"RATING FEEDBACK",
"message":"TEST PUSH",
"url":"https://www.notifyvisitors.com/"
}'
Note:
- Replace YOUR_API_KEY with NotifyVisitors' API key.
- Replace YOUR_BRAND_ID with NotifyVisitors' Brand id .
PARAMETERS
Below are the parameters you need to pass to the API endpoint for sending push notifications to the subscribers.
PARAMETERS | TYPE | DESCRIPTION |
---|---|---|
User id/subscription id | string | Unique identification ID of the user |
Notification id | int64 | Unique Id that is assigned to the users |
Tag | string | Tags are assigned to the users to segment them on the basis of certain factors |
Time | - | Default value for the time-to -live |
Title | string | Maximum character limit for the title |
URL | string | Call to action URL |
Image _URL | string | Image URL must be on HTTPs URL |
Hero_image URL | string | URL needs to be on HTTPs. Works only for chrome subscribers |
Button_one title | string | Maximum length of the call-to-action button, works only for chrome subscribers |
Button_two title | string | Allowed only in chrome version and above |
Button_two URL | string | Works only for chrome subscribers |
segment_ID | int64 | Unique segment ID |
Schedule _date | string | Date scheduled for sending push |
Schedule_time | string | Time scheduled for sending push |
Timezone | string | Time zone (default value 0) |
Hero_image URL | string | URL needs to be on HTTPs. Works only for chrome subscribers |
Updated over 3 years ago