Notifications (REST)

The Notifications Service is used to send email notifications through Relativity. The service uses internal Relativity's SMTP client , which is configured in Instance Settings. Review the topic Using the Notifications Service for important considerations on interacting with the service.

This service resides at the following URL:

Copy 
<host>/Relativity.REST/api/relativity-notifications/v1/workspaces/-1/notifications/email

Code Samples

To send a notification, issue a POST request with a URL in the following format:

Copy 
<host>Relativity.REST/api/relativity-notifications/v1/workspaces/-1/notifications/email
Copy
Sample JSON Request Body (note invalid email in recipients)
{
    "request": {
        "recipients":["name.surname@relativity.com", "namesurnamegmail.com"],
        "subject": "Email Notification Test",
        "body": "Body of the email."
    }
}
Copy
Sample JSON Response
{
    "EmailNotifications": [
        {
            "Recipient": "name.surname@relativity.com",
            "IsSent": true,
            "Message": "Email has been sent."
        },
        {
            "Recipient": "namesurnamegmail.com",
            "IsSent": false,
            "Message": "Recipient's or sender's email format is invalid.\" FormatException: The specified string is not in the form required for an e-mail address."
        }
    ]
}