ProgramTaskUpdateV1
Occurs when a task is updated.
Early Access
This service is subject to change with limited or no warning. Please work closely with your CSM and our Services team if you are interested in using this webhook.
Webhook Payload
The webhook event is encapsulated within a common wrapper structure providing general information about the event.
| Property | Type | Description |
|---|---|---|
| id | string | Unique event id |
| version | string | Event version |
| occurredAt | string | Timestamp of the event |
| tenantId | string | Tenant unique id (GUID) |
| tenantName | string | Tenant name |
| application | string | Application |
| productArea | string | Product area |
| data | object | The container of the event details data object details |
data object details
| Property | Type | Description |
|---|---|---|
| tenantId | string | The unique identifier of the tenant |
| tenantName | string | Tenant name |
| taskId | string | Task id |
| eventTimestamp | integer | Timestamp of the event |
| actorId | string | User id of the actor |
| spaceId | string | Space id |
| title | string | Task title |
| description | string | Task description |
| assigneeId | ['string', 'null'] | User id of the task assignee |
| assignerId | ['string', 'null'] | User id of the task assigner |
| creatorId | string | User id of the task creator |
| plannedStartDate | integer | The planned start date of the task |
| plannedEndDate | integer | The planned end date of the task |
| plannedDuration | integer | The planned duration in days of the task |
| actualStartDate | integer | Date when work on the task started |
| actualEndDate | integer | Date when work on the task was completed |
| actualDuration | integer | Calculated actual duration in days |
| createdAt | integer | The timestamp of the creation of the task |
| updatedAt | integer | The timestamp of the last update of the task |
| status | string | The status of the task |
| priority | ['string', 'null'] | Task priority |
| parentId | ['string', 'null'] | Task id of parent if task is a subtask |
| programId | string | Program id the task belongs to |
| copyFrom | ['string', 'null'] | Task id of the task that was copied from |
| templateId | ['string', 'null'] | Template id the task was created from |
| followers | array of objects | List of user ids that are following the task followers array object details |
| customProperties | array of objects | List of custom properties customProperties array object details |
| attachedContent | array of objects | List of attached content attachedContent array object details |
| attachedSubTasks | array of objects | List of attached sub tasks attachedSubTasks array object details |
| updateDiffs | array of objects | List of update diffs updateDiffs array object details |
followers array object details
| Property | Type | Description |
|---|---|---|
| userId | string | User id |
customProperties array object details
| Property | Type | Description |
|---|---|---|
| id | string | The unique identifier of the custom property |
| multipleValue | boolean | Indicate if the custom property allows multiple values |
| name | string | The name of the custom property |
| customProperties | array of objects | List of custom property values customProperties array object details |
customProperties array object details
| Property | Type | Description |
|---|---|---|
| id | string | The unique identifier of the custom property value |
| value | string | Value data for custom property value |
| type | ['string', 'null'] | The type of the custom property value |
attachedContent array object details
| Property | Type | Description |
|---|---|---|
| spaceId | string | Space id |
| contentId | string | Content id |
attachedSubTasks array object details
| Property | Type | Description |
|---|---|---|
| spaceId | string | Space id |
| taskId | string | Task id |
updateDiffs array object details
| Property | Type | Description |
|---|---|---|
| fieldName | ['string', 'null'] | Field name |
| before | ['string', 'null'] | The field value before the update |
| after | ['string', 'null'] | The field value after the update |
Example
{
"id": "215A44B475421CA5275FB62EC71475589EA0172EA71C1A01F675515C95A73F0C",
"version": "ProgramTaskUpdateV1",
"occurredAt": "2024-03-31T10:27:50.505Z",
"tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
"tenantName": "demo",
"data": {
"tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
"tenantName": "demo",
"taskId": "C4F1nPbqZkmLWt2M-TlxlA",
"eventTimestamp": 638474776705050000,
"actorId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf",
"spaceId": "7v08TiMbm0y6uxsQHldhUQ",
"title": "demo task",
"description": "<div>This is a demo task<br></div>",
"assigneeId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf",
"assignerId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf",
"creatorId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf",
"plannedStartDate": 638450874000000000,
"plannedEndDate": 638464698000000000,
"plannedDuration": 17,
"actualStartDate": 0,
"actualEndDate": 0,
"actualDuration": 0,
"createdAt": 638474729228660000,
"updatedAt": 638474776705050000,
"status": "not started",
"priority": "high",
"parentId": "t3lSocPyRkmgtCG-lROnkQ",
"programId": "NjF9VbraXkWl_z_QcfxL6g",
"copyFrom": "rrK02U_JakSf-hxfPJpjnQ",
"templateId": "4ZUtC0qrrUKdQmcqeLl9yQ",
"followers": [
{
"userId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf"
}
],
"customProperties": [
{
"id": "8DFDeqXPKk2ezl3L0iw_Lw",
"multipleValue": false,
"name": "justin-test-user123",
"customProperties": [
{
"id": "",
"value": "{\n \"id\": \"24O-Jkbed4vOoR0_li2wtw\",\n \"type\": \"user\"\n}",
"type": "JObject"
}
]
}
],
"attachedContent": [
{
"spaceId": "Jf4XD0B2wUKxFTW55h6MSw",
"contentId": "19917dbc-d59e-49dc-84c0-41d618a15e1c"
}
],
"attachedSubTasks": [
{
"spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
"taskId": "d4f13e72-0087-4212-a72d-f7fe73c44dd2"
},
{
"spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
"taskId": "c596cb97-56af-46bf-820d-757718e2c6bd"
}
],
"updateDiffs": [
{
"fieldName": "priority",
"before": "medium",
"after": "high"
}
]
},
"application": "EnablementPlannerService",
"productArea": "EnablementPlanner"
}
Updated 5 days ago