Notifications (REST API) | Pricefx Knowledge Base

The Notifications REST API (notification.send endpoint) lets you trigger in-app notifications by specifying a topic, status, and action type, along with any additional required parameters such as action and actionLabel for context-link actions. This page explains the supported values, casing rules, and validation behavior so you can integrate notifications reliably without needing backend assistance.

Request Body Values

Request Body Item	Value	Description
topic	`CALCULATION` `DATA_DOWNLOAD` `MESSAGE` `GROOVY` `VALIDATION` `ACTION` `SUBMIT_FOR_APPROVAL` `IMPORT_MANAGER` `SYSTEM_NOTIFICATION` `COPILOT`
status	`INFO` `WARNING` `ERROR` `SUCCESS`
actionType	`LINK` `DOWNLOAD` `INFO_MESSAGE` `MESSAGE_LINK` `CTX_LINK` `CTX_LINK_AND_TOAST`	`LINK` – used for the known internal application link on FE from BE side. `DOWNLOAD` – command for the file download expected in an action field. `INFO_MESSAGE` – used for informational notification without action link. `MESSAGE_LINK` – specific for linking to messages e.g. in Quotes, Deal Plans, etc. `CTX_LINK` – used for creating context links. `CTX_LINK_AND_TOAST` – used for creating context links including toast message.
action	Example: JSON `"action" : "{ \"targetPage\"： \"agentsPage\"，\"targetPageState\"：{ \"id\"： \"6.M0\"}}"`	There is a 2000 characters length limitation applied on `action`. For more information see Validation Logic Table.
actionLabel	Example: `Agent`	There is a 255 characters length limitation applied on `actionLabel`. For more information see Validation Logic Table.

Note that the UNKNOWN value is invalid for both status and actionType request body items.

Validation Logic Table

Case	actionLabel	action	Length of actionLabel	Result	Description
1	Blank	Blank	N/A	✅ Valid	If `actionLabel` is blank, validation passes immediately.
2	Blank	Not blank	N/A	✅ Valid	`actionLabel` blank → no further checks.
3	Not blank	Blank	N/A	❌ Invalid	`actionLabel` is set but `action` is missing → invalid.
4	Not blank	Not blank	Within max length	✅ Valid	All conditions satisfied.
5	Not blank	Not blank	Exceeds max length	❌ Invalid	`actionLabel` exceeds allowed length.

Examples

Notification Type	Request Body	Message
Error Notification	JSON `{ "data": { "notification": { "title": "Notification title", "message": 'The notification messsage.', "source": "notification source", "status": "ERROR", "topic": "VALIDATION", "actionType": "INFO_MESSAGE", } } }`
Context Link to a Specific Object	JSON `{ "data": { "notification": { "title": "Context Link Notification", "message": 'This notification should contain a context link to a model object.', "source": "notification source", "status": "SUCCESS", "topic": "COPILOT", "actionType": "CTX_LINK", "action": "{ \"targetPage\": \"modelsObjectsPage\",\"targetPageState\": { \"id\": \"49.MO\"}}", "actionLabel": "View Model", } } }`

Notification Type

Request Body

Message

Error Notification

JSON

{
    "data": {
        "notification": {
            "title": "Notification title",
            "message": 'The notification messsage.',
            "source": "notification source",
            "status": "ERROR",
            "topic": "VALIDATION",
            "actionType": "INFO_MESSAGE",
        }
    }
}

Context Link to a Specific Object

JSON

{
    "data": {
        "notification": {
            "title": "Context Link Notification",
            "message": 'This notification should contain a context link to a model object.',
            "source": "notification source",
            "status": "SUCCESS",
            "topic": "COPILOT",
            "actionType": "CTX_LINK",
            "action": "{ \"targetPage\": \"modelsObjectsPage\",\"targetPageState\": { \"id\": \"49.MO\"}}",
            "actionLabel": "View Model",
        }
    }
}