Alerts Requests

Orchestrator integrates with Notification Service and uses the Automation Cloud Alerts framework. As a result, most alert operations, such as listing alerts and marking them as read, are exposed through the Automation Cloud Alerts API rather than a dedicated Orchestrator API.

For details, check the Alerts section in the Automation Cloud API guide.

Orchestrator does expose a dedicated endpoint for raising process alerts.

Raising a process alert

The following request enables you to create a process alert tied to a specific process and robot, with a chosen severity.

POST

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert

Required permissions

Alerts.Create

Request headers

Key	Value
Authorization	Bearer
X-UIPATH-OrganizationUnitId	Folder Id
X-UIPATH-JobKey	Job Key

Request body

{
    "processAlert": {
        "Message": "The invoice processing job stopped unexpectedly.",
        "Severity": "Error",
        "ProcessName": "InvoiceProcessing",
        "RobotName": "FinanceBot01"
    }
}

Request body parameters

Parameter	Type	Required	Description
processAlert.Message	String	Yes	The alert message. Maximum 512 characters.
processAlert.Severity	Enum	Yes	The severity level of the alert: Info, Success, Warn, Error, Fatal.
processAlert.RobotName	String	Yes	The name of the robot that executed the process. Maximum 512 characters.
processAlert.ProcessName	String	Yes	The name of the process that generated the alert. Maximum 512 characters.

Response code

200 OK