Risk Cloud API: Post Record Comments

Updated on: February 02, 2024

Creating comments via the Risk Cloud API allows custom integrations to post contextual updates to records to keep related information from external sources centralized in the Risk Cloud.

In this article, we will walk through the steps necessary for posting a comment to a record via the Risk Cloud API.

  1. Obtain the record-id of the record that you would like to post the comment to
  2. Post Record Comment
POST/api/v1/comments

Authentication

Obtain your API Access Token to get started.

Comments Feature

Ensure that the Comments feature is enabled for your step. To enable comments on a record step:

  • Navigate to the step via Build > Applications > Open an application > Open a step in a workflow > Configure Step
  • Check the box "Enable Comments"

Step 1: Obtain the record-id

The record-id can be obtained from the Risk Cloud web application, emails, or via the Risk Cloud API. If you already know your record-id you may continue to Step 2: Post Record Comment

Using the Risk Cloud application

The most straightforward way to find the record ID for record-id is to open the desired record in the Risk Cloud web application, then take the ID from the end of the URL.

https://your-company.logicgate.com/records/{record-id}

Using email

The Contextual Notifications feature offers the ability to set Custom Fields and System Fields in outbound emails. As a result, Record ID is a System Field that can be included in outbound emails from the Risk Cloud. This Record ID could in turn be parsed from the email for use in the following Post Record Comment API request.

Using the Risk Cloud API

Reference the article Risk Cloud API: Record Search to obtain record IDs via the Risk Cloud API.

2. Post Record Comment

In this step, we will use the record-id found in the previous step to create a comment. Additionally you will require the text of the post in Rich Text HTML format.

POST/api/v1/comments
Sample Request Body
{ 
  "record": {
    "id": "record-id"
  },
  "content": "<p>Your comment here.</p>"
}
Response

A 200 response with JSON confirming the structure of the new comment.