Create a new notification

post

https://platform.{env}.simpplr.com/v1/notifications

This API allows you to create a new notification for a user.

Body Params

category

string

enum

required

This is to identify type of notification. Currently only inapp category is supported.

Allowed:

sentTo

string

The Email-id of the person who will be receiving this notification.

sentBy

string

The Email-id of the person of the person who is sending notification.

url

string

You can add link to notification and the user is redirected to it when he clicks the notification.

message

string

required

The notificatoin message that will be display to user. {{fullName}} variable can be used in message to display the sender name.

notificationType

string

enum

The notification could be either activity or actionable. actionable - Notifications which require some action, like a follow request, leave approval. activity- Notification which publishes some information default will be activity

Allowed:

Responses

Language

Credentials

OAuth2

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Error

401Authorize error

403Forbidden error