Update task

Lenders can now trigger a service order to partners using workflow rules. If these workflow rules are triggered from a newly created task in Encompass, partners will get the newly created taskId with the webook notification. UPDATE_TASK result action can be used update or close the task.

📘

Prerequisites

Product has to be entitled to UPDATE_TASK action in order to use it via transaction patch.

A product can be entitled to UPDATE_TASK action by adding it in the response.results array of the specific request type within $.entitlements.data.transaction.

          {
            "action": "UPDATE_TASK",
            "formats": [
              "application/vnd.task.update-1.0.0.json"
            ]
          }

The specific fields that are sent as part of the response loan data follow the standard data entitlement model and process.

{
    "status": "processing",
    "loanFormat": "application/vnd.plm-2.0.0+json",
    "loan": {
        ... // Additional loan data, sent as part of standard transaction loan update
    },
    "result": {
        "action": "UPDATE_TASK",
        "format": "application/vnd.task.update-1.0.0.json",
        "details": {
            ... // update task action details
        }
    },
    "partnerStatus": "partner status"
}

📘

format and action

The Encompass Partner Connect Platform (EPC) uses $.result.format and $.result.action to properly handle the action details sent in the transaction PATCH payload. Make sure you use:

"format": "application/vnd.task.update-1.0.0.json"
"action": "UPDATE_TASK"

List of fields in the UPDATE_TASK result action:

The complete list of supported fields in the update credit data action details is captured in the JSON-schema object definition below. You can use online resources such as JSON Schema Validator to manually validate result details objects content.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the task."
    },
    "status": {
      "type": "string",
      "enum": [
        "IN_PROGRESS",
        "COMPLETED"
      ],
      "description": "The current status of the task."
    },
    "comment": {
      "type": "string",
      "description": "An optional comment associated with the task."
    }
  },
  "required": [
    "id",
    "status"
  ],
  "additionalProperties": false
}

Sample update credit data request payload with most of the fields supported:

{
    "status": "processing",
    "loanFormat": "application/vnd.plm-2.0.0+json",
    "result": {
        "format": "application/vnd.task.update-1.0.0.json",
        "action": "UPDATE_TASK",
        "details": {
            "id": "cbb20fc3-ddd6-4d71-8776-599636194822",
            "status": "IN_PROGRESS",
            "comment": "Team still working on it"
        },
        "partnerStatus": "partner status"
    }
}