Get workflow notifications

Get the workflow notifications for a particular workflow process.

Get workflow notifications

GET https://ris.rightsline.com/v4/processes/:processID/notifications

This endpoint allows you to retrieve workflow notifications for a given workflow process.

Path Parameters

NameTypeDescription

processID*

int

The workflow process ID.

Headers

NameTypeDescription

x-api-key*

string

Your company's API key.

Authentication*

string

Authentication token.

{
    "notifications": [
        {
            "notificationId": 1,
            "notificationName": "Send Long Form Notification                                                                                                                                                                             ",
            "sequenceNumber": 1,
            "subject": "Long form for <<transaction.entity_title>> attached.",
            "previewBeforeSend": true,
            "addActionButton": false,
            "triggerMessage": false,
            "plainText": "",
            "html": "",
            "attachmentTypes": [
                {
                    "templateId": 9,
                    "templateName": "Test Draft Template",
                    "templateDescription": "Test Draft Template",
                    "fileName": "Deal_Draft_Template.docx"
                }
            ]
        },
        {
            "notificationId": 2,
            "notificationName": "Approve/Reject Deal                                                                                                                                                                                     ",
            "sequenceNumber": 2,
            "subject": "Approval Requested on Deal <<transaction.entity_id>>",
            "previewBeforeSend": true,
            "addActionButton": true,
            "triggerMessage": false,
            "plainText": "Hello <<recipient.entity_title>>,\n\nYour approval is requested on the following Deal <<transaction.entity_title>>.",
            "html": "<p>Hello <i>&lt;&lt;recipient.entity_title&gt;&gt;</i>,</p><p>Your approval is requested on the following Deal: <b>&lt;&lt;transaction.entity_title&gt;&gt;</b>.</p>",
            "attachmentTypes": [
                {
                    "templateId": 2,
                    "templateName": "Sales Sheet",
                    "templateDescription": "Sales Sheet",
                    "fileName": "RL_SALES_SHEET.docx"
                }
            ]
        }    
    ]
}

Last updated