Notifications API

Get Notifications for a user and send read status.

Get Notifications

GET https://2i339xpjwf.execute-api.us-east-1.amazonaws.com/prod

This lets you request all the notifications for a given user.

Query Parameters

Name	Type	Description
notification_type	string	This could be eithere 'chat' or 'notification'. These are only two accepted value and defaults to 'notification'. Since we treat notifications as a interaction between platform and user. Hence we can display the response in chat format or notifications format.
category	string	This could either be 'get_list' (gets you list of all notifications for this user) or 'read_status_update' lets you update the read status of all notification for this user.(you cannot mark individual notification as read) or 'unread_count' : lets you get a count of total unread notifications for this user.
user_id	number	This is the user_id of the job seeker and not the 'id' value. Every Job Seeker has a 'user_id' send that id to get all notifications.
api_key	string	The API key for the tenant. Not the user token.
tenant	string	The tenant id for authentication.

200 For Category: "get_list" Array of notifications. Subject: Subject of an email or title of notifications. Body: body or content of the notification. action_url: url that could be triggered globally for notification. actionurl_btn: the call to action button on the url. channel_type: how it was delivered. content_type: category of notification created_at: when was this notification cretaed. read_status: if the notification is already read or not. read_time: when was this read.

###respose for 'get_list'

[{
"subject":"New shifts for you Standard Driver",
"body":"There are new shifts available in your account. Please click below to see more and request to work",
"content":"system_message: New shifts for you Standard Driver There are new shifts available in your account. Please click below to see more and request to work",
"action_url":"https://wolfdemo.ondemandstaffing.app/",
"actionurl_btn":"Request to work",
"channel_type":"Email",
"content_type":"new_notification",
"created_at":"2020-02-24 21:01:41 +0000",
"read_status":"read",
"read_time":"2020-02-26 16:28:56 +0000"
},
{...}
]

______
###response for 'unread_count'

{'unread_count': 12}

______
###response for 'read_status_update'

{'status': 'updated'}

404 Could not find any user or notifications for this user.

{    "message": "Did not find any notifications"}