Risk Cloud API: Create Records

Updated on: April 05, 2024

Creating records is an essential capability in the Risk Cloud, and with Risk Cloud’s Record API, you can create new Risk Cloud records, populate field data, schedule due dates, and set assignees via the Risk Cloud API.

Obtain your API Access Token or pull the Risk Cloud Postman Collection to get started.

Create Records Endpoint

The Record API offers the following Create Records endpoint which creates a record on a given step with configurable field values and assignees.

The Create Records endpoint requires that the user whose API token is being used for the request is entitled with Write access to create records on the given step.

POST/api/v1/records/steps

This endpoint has the following request body properties.

{
  "stepId": "a1b2c3d4",
  "assigneeEmailAddress": "[email protected]"
  "fields": [
    {
      "fieldId": "e5f6g7h8",
      "values": [
        "The string value of the field"
      ]
    }
  ]
}
Property Requiredness Description
stepId required The unique ID of the step to create a record on.
assigneeEmailAddress optional The email of a Risk Cloud user to assign the record to.
recordDueDate optional A generic date string for setting the due date of the created record (e.g 2024-04-05 12:00:00)
fields optional An array of field IDs and values to set to their corresponding fields on the created record.
fields > fieldId required The unique ID of the field to set the values to on the created record.
fields > values required An array of strings representing the text values to set to the fields of the corresponding field IDs on the created record.

Resources

Get Step ID

The step ID for the stepId property can be obtained from either your Risk Cloud web app environment directly or from the Risk Cloud API.

Get Step ID (Web App Environment)

The step ID can be located within your Risk Cloud web app environment in the following location:

  • Navigate to Build > Applications
  • Search for and open the application containing the step
  • Open the workflow containing the step
  • Open the step
  • The step ID can be found in the web browser URL bar https://environment.logicgate.com/build/steps/{step-id}

Get Step ID (Risk Cloud API)

The step ID can be located via the Retrieve Steps endpoint, specifically in the id property of step objects returned in the content property of the response.

GET/api/v2/steps

Get Field ID

The field ID for the fieldId property can be obtained from either your Risk Cloud web app environment directly or from the Risk Cloud API.

Get Field ID (Web App Environment)

The field ID can be located within your Risk Cloud web app environment in the following location:

  • Navigate to Build > Applications
  • Search for and open the application containing the step
  • Open the workflow containing the step
  • Open the step
  • Open the field for editing
  • The field ID can be found in the Field ID section

Get Field ID (Risk Cloud API)

The field ID can be located via the Retrieve Fields endpoint, specifically in the id property of field objects returned in the content property of the response.

GET/api/v2/fields