API Directory

This API is used to send notifications through Jinie.

Request

POST https://domain.peoplestrong.com/api/bot/v1/notify

Request body

The request body takes a complete Notification Request Object resource, containing the following writable properties:

{
    "input": {
        "messageType": "string",
        "usersList": {
            "emailId": "string",
            "organizationId": "string",
            "text": {
                "design": {
                    "label": "string",
                    "type": "string"
                }
            },
            "userId": "string"
        }
    }
}

Properties

Name Type Description Additional
input object

This the details of the notification

Optional
input.messageType string

Category of message whose notificaiton has to be send

Optional
input.usersList object Optional
input.usersList.emailId string

emailId for the reciepient User

Optional
input.usersList.organizationId string

OrgCode of the employee

Optional
input.usersList.text object

This object is the list of UI component

Optional
input.usersList.text.design object

This object is the individual of UI component

Optional
input.usersList.text.design.label string Optional
input.usersList.text.design.type string Optional
input.usersList.userId string

Alt UserId for the reciepient User

Optional

Authorisation

This request requires the use of one of following authorisation methods: API key OAuth2.

For OAuth 2 authorisation, the following scopes are required:

Scope Description
read read records
write modify records

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

Request Object
401 Unauthorized

No API key found in request

Token Error
403 Forbidden

Your IP address is not allowed

Forbidden
404 Not Found

no route and no API found with those values

API rate limit exceeded
405 Method Not Allowed

API rate limit exceeded

API rate limit exceeded
426

Please use HTTPS protocol

Use HTTPS

Explore this API

body
Request Content-Type
Response Content-Type

Choose an authorisation method:

API key API key to be used for request
Access Token Access token to be used for request
Try it out!