Workflow Tasks

Subtask Resource Events

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

EventDescriptionSupport
CreateWhen a new subtask is created.Smart Client, API
UpdateWhen a subtask is updated.Smart Client, API
DeleteWhen subtask is deleted.Smart Client, API

Task Group Resource Events

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

EventDescriptionSupport
CreateWhen a new task group is created.Smart Client, API
UpdateWhen a task group is updated.Smart Client, API
DeleteWhen task group is deleted.Smart Client, API

Task Resource Events

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

EventDescriptionSupport
CreateWhen a new task is created.Smart Client, API
UpdateWhen a task is updated.Smart Client, API
DeleteWhen task is deleted.Smart Client, API

Notification Message

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.

{
  "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"
      }
    ]
  }
}

Back to Webhooks Overview