Create Notification

POST

/v2/api/notification

Enables authenticated users to create and send a notification to a specific user within an organization. Notifications can optionally be associated with a specific agent and typically serve to inform the recipient about relevant system events, tasks, or updates.

Functionality Overview:

Requires user_id, org_id, and content as mandatory fields.

Allows optional association with an agent_id to link the notification contextually.

Returns detailed metadata about the newly created notification, such as its ID, read status, creation timestamp, and recipient information.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/notification' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id": 147,
    "agent_id": 1297,
    "org_id": 1,
    "content": "Testing Notification API"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "Notification created successfully.",
    "data": {
        "id": 71609,
        "content": "Testing Notification API",
        "is_read": false,
        "created_on": "2025-02-04T19:11:39.239363Z",
        "is_deleted": false,
        "redirection_details": {},
        "recipient": 147,
        "org": 1,
        "agent": 1297
    }
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Notification created successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Trigger a refresh(reindex) of a Corpus

Retrieve All Notifications