Extra Payload Attributes - Task

These attributes make up the extra payload for the Task webhook resource for the following events: Create / Update / Delete

Create / Update Attributes

ATTRIBUTE	DESCRIPTION
id string	The payload ID.
entity.entityId string	The entity ID.
entity.entityType string	The entity type (e.g., Task).
action string	The action type (e.g., CREATE, UPDATE).
modified string	The informational timestamp when the audit history record of the Task is created/updated.
modifiedBy string	The modifying user.
type string	The payload type.
modifiedAttributes.attribute string	The modified attribute. Note: The “modifiedAttributes.lastModified” attribute is different from the “payload.modified” attribute. Therefore, modifiedAttributes.lastModified attribute should be used for any timestamp-based references or downstream processing.
modifiedAttributes.priorValue string	The prior value of the modified attribute.
modifiedAttributes.newValue string	The new value of the modified attribute.

Delete Attributes

ATTRIBUTE	DESCRIPTION
id string	The payload ID.
entity.entityId string	The entity ID.
entity.entityType string	The entity type (e.g., Task).
action string	The action type (e.g., DELETE).
modified string	The informational timestamp when the audit history record of the Task is deleted.
modifiedBy string	The modifying user.
type string	The payload type.

Webhook Payload Notification Samples

{
    "eventId": "2b8aea16-08f6-4111-a3a5-7e1096e4b57c",
    "eventTime": "2024-12-11T21:16:28.000Z",
    "eventType": "create",
    "meta": {
        "userId": "admin",
        "resourceType": "Task",
        "resourceId": "63a13d45-8a1a-421a-b440-8c818ebca79b",
        "instanceId": "be11172718",
        "resourceRef": "workflow/v1/tasks/63a13d45-8a1a-421a-b440-8c818ebca79b",
        "payload": {
            "id": "80b36f81-a8eb-401a-8276-885a0cf6c316",
            "entity": {
                "entityId": "63a13d45-8a1a-421a-b440-8c818ebca79b",
                "entityType": "Task"
            },
            "action": "CREATE",
            "modified": "2024-12-11T21:16:25.052Z",
            "modifiedBy": "admin",
            "type": "Review Income_type_4933769",
            "modifiedAttributes": [
                {
                    "attribute": "autocomplete",
                    "priorValue": null,
                    "newValue": "false"
                },
                {
                    "attribute": "durationFormat",
                    "priorValue": null,
                    "newValue": "Day"
                },
                {
                    "attribute": "overrideDue",
                    "priorValue": null,
                    "newValue": "false"
                },
                {
                    "attribute": "id",
                    "priorValue": null,
                    "newValue": "63a13d45-8a1a-421a-b440-8c818ebca79b"
                },
                {
                    "attribute": "instanceId",
                    "priorValue": null,
                    "newValue": "BE11172718"
                },
                {
                    "attribute": "name",
                    "priorValue": null,
                    "newValue": "Review Income_4933769"
                },
                {
                    "attribute": "description",
                    "priorValue": null,
                    "newValue": "Review Income"
                },
                {
                    "attribute": "type",
                    "priorValue": null,
                    "newValue": "Review Income_type_4933769"
                },
                {
                    "attribute": "associations",
                    "priorValue": null,
                    "newValue": "[{\"entityId\":\"1\",\"entityType\":\"urn:elli:encompass:role\",\"relationship\":\"Assignee\"}]"
                },
                {
                    "attribute": "required",
                    "priorValue": null,
                    "newValue": "true"
                },
                {
                    "attribute": "status",
                    "priorValue": null,
                    "newValue": "NOT_STARTED"
                },
                {
                    "attribute": "priority",
                    "priorValue": null,
                    "newValue": "1"
                },
                {
                    "attribute": "rank",
                    "priorValue": null,
                    "newValue": "1"
                },
                {
                    "attribute": "created",
                    "priorValue": null,
                    "newValue": "2024-12-11T21:16:25.045Z"
                },
                {
                    "attribute": "lastModified",
                    "priorValue": null,
                    "newValue": "2024-12-11T21:16:25.045Z"
                },
                {
                    "attribute": "createdBy",
                    "priorValue": null,
                    "newValue": "admin"
                },
                {
                    "attribute": "lastModifiedBy",
                    "priorValue": null,
                    "newValue": "admin"
                }
            ]
        }
    }
}

{
    "eventId": "0e02fbc4-8f32-4284-afe4-c4fcb6d4602a",
    "eventTime": "2024-12-11T21:16:38.000Z",
    "eventType": "update",
    "meta": {
        "userId": "admin",
        "resourceType": "Task",
        "resourceId": "63a13d45-8a1a-421a-b440-8c818ebca79b",
        "instanceId": "be11172718",
        "resourceRef": "workflow/v1/tasks/63a13d45-8a1a-421a-b440-8c818ebca79b",
        "payload": {
            "id": "dd5a256a-9283-4cb2-97c3-04af7ea63e7b",
            "entity": {
                "entityId": "63a13d45-8a1a-421a-b440-8c818ebca79b",
                "entityType": "Task"
            },
            "action": "UPDATE",
            "modified": "2024-12-11T21:16:33.565Z",
            "modifiedBy": "admin",
            "type": "Review Income_type_4933769",
            "modifiedAttributes": [
                {
                    "attribute": "started",
                    "priorValue": null,
                    "newValue": "2024-12-11T21:16:33.563Z"
                },
                {
                    "attribute": "status",
                    "priorValue": "NOT_STARTED",
                    "newValue": "IN_PROGRESS"
                },
                {
                    "attribute": "resolution",
                    "priorValue": null,
                    "newValue": "IN_PROGRESS"
                },
                {
                    "attribute": "resolutionComment",
                    "priorValue": null,
                    "newValue": "this is test"
                },
                {
                    "attribute": "lastModified",
                    "priorValue": "2024-12-11T21:16:25.045Z[GMT]",
                    "newValue": "2024-12-11T21:16:33.564Z"
                }
            ]
        }
    }
}

{
    "eventId": "d566abb9-1643-4155-a526-5323d7ff0d60",
    "eventTime": "2024-12-11T21:16:43.000Z",
    "eventType": "delete",
    "meta": {
        "userId": "admin",
        "resourceType": "Task",
        "resourceId": "63a13d45-8a1a-421a-b440-8c818ebca79b",
        "instanceId": "be11172718",
        "resourceRef": "workflow/v1/tasks/63a13d45-8a1a-421a-b440-8c818ebca79b",
        "payload": {
            "id": "056c23f8-c8ca-8717-fd24-d287b1dab225",
            "entity": {
                "entityId": "63a13d45-8a1a-421a-b440-8c818ebca79b",
                "entityType": "Task"
            },
            "action": "DELETE",
            "modified": "2024-12-11T21:16:41.45Z",
            "modifiedBy": "admin",
            "type": "Review Income_type_4933769"
        }
    }
}