Workflow Tasks

Subtask Resource Events

The following events are supported by the Webhook API for the Subtask resource:

Event	Description	Support
Create	When a new subtask is created.	Smart Client, API
Update	When a subtask is updated.	Smart Client, API
Delete	When subtask is deleted.	Smart Client, API

Task Comment Resource Events

This webhook added with the 24.2 release of Encompass.

Event	Description	Support
Update	When a task comment is added and or when a workflow task disposition is added or changed. If the task comment disposition is updated (added or changed), a new entry in the task comment table is generated. Extra payload is included in the webhook notification. See the Task Comment Extra Payload Contract Attributes for details.	Smart Client, API

Task Comment Extra Payload Contract Attributes

The following event is supported by the Webhook API for the TaskComment resource:

Attribute	Description
Id	Unique identifier of the task comment.
entityId	Unique identifier of the task that the comment is associated with.
entityType	The entity type. Example: TaskComment
action	The TaskComment action. Supported value includes: UPDATE
modified	The date and time stamp of when the task comment was modified. Example: "2024-01-25T21:06:36.07Z"
modifiedBy	The username of the user who modified the task comment.
modifiedAttributes.attribute	The modified attribute name. The attribute indicates the data type included in the prior and new value. The prior value is always set to null, since the webhook event is generated whenever a new comment record is added. The included attributes in every payload are the following: - Id - entityId - entityType - commentText - created - lastModified - createdBy - lastModifiedBy
modifiedAttributes.priorValue	Will always be null.
modifiedAttributes.newValue	The attribute value for the newly added comments record.

Notification Message

{
  "eventId": "3f1be1e8-b818-497f-a943-c1bf67b788ac",
  "eventTime": "2024-06-07T05:43:07.000Z",
  "eventType": "update",
  "meta": {
    "userId": "admin",
    "resourceType": "TaskComment",
    "resourceId": "6ef7c9a9-cfa8-4495-b333-dd1dceff473a",
    "instanceId": "be11200922",
    "resourceRef": "workflow/v1/comments/6ef7c9a9-cfa8-4495-b333-dd1dceff473a",
    "payload": {
      "id": "6a56a0b2-bcf1-4204-92b6-d1158b77ddb7",
      "entity": {
        "entityId": "6ef7c9a9-cfa8-4495-b333-dd1dceff473a",
        "entityType": "Comment"
      },
      "action": "UPDATE",
      "modified": "2024-06-07T05:43:04.741Z",
      "modifiedBy": "admin",
      "modifiedAttributes": [
        {
          "attribute": "id",
          "priorValue": null,
          "newValue": "6ef7c9a9-cfa8-4495-b333-dd1dceff473a"
        },
        {
          "attribute": "entityId",
          "priorValue": null,
          "newValue": "7114c055-9351-4e44-84f6-3d20966c267f"
        },
        {
          "attribute": "entityType",
          "priorValue": null,
          "newValue": "Task"
        },
        {
          "attribute": "commentText",
          "priorValue": null,
          "newValue": "Test 22600"
        },
        {
          "attribute": "created",
          "priorValue": null,
          "newValue": "2024-06-07T05:43:04.708Z"
        },
        {
          "attribute": "lastModified",
          "priorValue": null,
          "newValue": "2024-06-07T05:43:04.708Z"
        },
        {
          "attribute": "createdBy",
          "priorValue": null,
          "newValue": "admin"
        },
        {
          "attribute": "lastModifiedBy",
          "priorValue": null,
          "newValue": "admin"
        }
      ]
    }
  }
}

Task Group Resource Events

The following events are supported by the Webhook API for the Task Group resource:

Event	Description	Support
Create	When a new task group is created.	Smart Client, API
Update	When a task group is updated.	Smart Client, API
Delete	When task group is deleted.	Smart Client, API

Notification Message

{
  "userId": "e2etesting_lo",
  "instanceId": "DEBE11170913",
  "eventId": "8acfbae6-3b73-4209-bf80-9491e443616b",
  "time": "2020-12-08T06:17:46Z",
  "eventType": "CREATE",
  "resourceType": "TASKGROUP",
  "resourceId": "7596b92c-bb83-44bb-bcb8-dc42ef863571",
  "baseRef": "workflow/v1/taskgroups",
  "payload": {
    "id": "8acfbae6-3b73-4209-bf80-9491e443616b",
    "entity": {
      "entityId": "7596b92c-bb83-44bb-bcb8-dc42ef863571",
      "entityType": "TaskGroup"
    },
    "action": "CREATE",
    "modified": "2020-12-08T06:17:46Z",
    "modifiedBy": "e2etesting_lo",
    "workEntity": {
      "entityId": "5f831dd0-1c76-447b-aede-220a79ade831",
      "entityType": "urn:elli:encompass:loan"
    },
    "type": "type_6b4191fc-1ae8-46c8-bd71-3c8a42e0152e",
    "modifiedAttributes": [
      {
        "attribute": "workEntityId",
        "priorValue": null,
        "newValue": "5f831dd0-1c76-447b-aede-220a79ade831"
      },
      {
        "attribute": "workEntityType",
        "priorValue": null,
        "newValue": "urn:elli:encompass:loan"
      },
      {
        "attribute": "autocomplete",
        "priorValue": null,
        "newValue": "true"
      },
      {
        "attribute": "id",
        "priorValue": null,
        "newValue": "7596b92c-bb83-44bb-bcb8-dc42ef863571"
      },
      {
        "attribute": "instanceId",
        "priorValue": null,
        "newValue": "BE11200922"
      },
      {
        "attribute": "name",
        "priorValue": null,
        "newValue": "TGTest_6b4191fc-1ae8-46c8-bd71-3c8a42e0152e"
      },
      {
        "attribute": "description",
        "priorValue": null,
        "newValue": "Desc_6b4191fc-1ae8-46c8-bd71-3c8a42e0152e"
      },
      {
        "attribute": "type",
        "priorValue": null,
        "newValue": "type_6b4191fc-1ae8-46c8-bd71-3c8a42e0152e"
      },
      {
        "attribute": "required",
        "priorValue": null,
        "newValue": "true"
      },
      {
        "attribute": "status",
        "priorValue": null,
        "newValue": "NOT_STARTED"
      },
      {
        "attribute": "resolution",
        "priorValue": null,
        "newValue": "Waived"
      },
      {
        "attribute": "created",
        "priorValue": null,
        "newValue": "2020-12-01T18:21:05.188Z"
      },
      {
        "attribute": "lastModified",
        "priorValue": null,
        "newValue": "2020-12-01T18:21:05.188Z"
      },
      {
        "attribute": "createdBy",
        "priorValue": null,
        "newValue": "e2etesting_lo"
      },
      {
        "attribute": "lastModifiedBy",
        "priorValue": null,
        "newValue": "e2etesting_lo"
      }
    ]
  }
}

Task Resource Events

The following events are supported by the Webhook API for the Task resource:

Event	Description	Support
Create	When a new task is created.	Smart Client, API
Update	When a task is updated.	Smart Client, API
Delete	When task is deleted.	Smart Client, API

When a subscription is registered, the client application issues a POST notification to the callback URL (endpoint) you defined in the webhook. The notification is sent as JSON in the POST request body.

Back to Webhooks Overview