ProgramRequestUpdateV1

Occurs when a request 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
requestId	string	The unique id of the request
eventTimestamp	integer	The timestamp of the event
actorId	string	The unique id of the actor
spaceId	string	The unique id of the space
title	string	The title of the request
description	string	Task description
assigneeId	['string', 'null']	The unique id of the request assignee
assignerId	['string', 'null']	The unique id of the request assigner
creatorId	string	The unique id of the request creator
plannedStartDate	integer	The planned start date of the request
plannedEndDate	integer	The planned end date of the request
plannedDuration	integer	The planned duration in days of the request
createdAt	integer	The timestamp of the creation of the request
updatedAt	integer	The timestamp of the last update of the request
status	string	The status of the request
priority	['string', 'null']	Request priority
programId	['string', 'null']	Program id of the program the request is associated with
note	['string', 'null']	Note for notifications on status changes
formRef	object	The reference to the form formRef object details
followers	array of objects	The list of followers followers array object details
customProperties	array of objects	The list of custom properties customProperties array object details
attachedContent	array of objects	The list of attached content attachedContent array object details
updateDiffs	array of objects	The list of update diffs updateDiffs array object details

formRef object details

Property	Type	Description
formId	string	The unique id of the request form
minorVersion	integer	The number of minor version of the request form
majorVersion	integer	The number of major version of the request form

followers array object details

Property	Type	Description
userId	string	The unique id of the user

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', 'null']	Value data for custom property value
type	string	The type of the custom property value

attachedContent array object details

Property	Type	Description
spaceId	['string', 'null']	The unique id of the space
contentId	string	The unique id of the content

updateDiffs array object details

Property	Type	Description
fieldName	['string', 'null']	The name of the field
before	['string', 'null']	The field value before the update
after	['string', 'null']	The field value after the update

Example

{
  "id": "21E4431256830E0A44C739FFBF930D26DED9D9539AB1C179F2D904D17E1662E4",
  "version": "ProgramRequestUpdateV1",
  "occurredAt": "2024-03-31T10:35:47.18Z",
  "tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
  "tenantName": "demo",
  "data": {
    "tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
    "tenantName": "demo",
    "requestId": "GeDorid95kCn8hqoOaJCLw",
    "eventTimestamp": 638474781471800000,
    "actorId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf",
    "spaceId": "7v08TiMbm0y6uxsQHldhUQ",
    "title": "demo request",
    "description": "<div>This is a demo request<br></div>",
    "assigneeId": "24a57a3b-a9b9-10a7-9b7a-662d88f5efdc",
    "assignerId": "24a57a3b-a9b9-10a7-9b7a-662d88f5efdc",
    "creatorId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf",
    "plannedStartDate": 638457786000000000,
    "plannedEndDate": 638465562000000000,
    "plannedDuration": 10,
    "createdAt": 638474780576160000,
    "updatedAt": 638474781471800000,
    "status": "pending",
    "priority": null,
    "programId": "SDSlTN4LhUCdUB2ezuvwTQ",
    "note": null,
    "formRef": {
      "formId": "W3s3PhZGIkqJnRxwPPPWiw",
      "minorVersion": 1,
      "majorVersion": 0
    },
    "followers": [
      {
        "userId": "b26fa7a6-5060-7ce1-8cf2-9fc6a414dfdf"
      }
    ],
    "customProperties": [
      {
        "id": "7O02uinYTEOGTNKAFIF5QA",
        "multipleValue": false,
        "name": "Date",
        "customProperties": [
          {
            "id": "",
            "value": "2024-03-19T18:30:00.0000000+00:00",
            "type": "DateTime"
          }
        ]
      },
      {
        "id": "OenCAqm_lEyWx1vZIwoWXw",
        "multipleValue": false,
        "name": "Decimal number",
        "customProperties": [
          {
            "id": "",
            "value": "1.1",
            "type": "double"
          }
        ]
      },
      {
        "id": "YETteAA0y0upM6iy22TLwA",
        "multipleValue": true,
        "name": "Multi-select",
        "customProperties": [
          {
            "id": "HgUfXzC5wUKafJXHx7imbA",
            "value": "1",
            "type": "JValue"
          }
        ]
      },
      {
        "id": "8DFDeqXPKk2ezl3L0iw_Lw",
        "multipleValue": false,
        "name": "test",
        "customProperties": [
          {
            "id": "",
            "value": "{\n  \"id\": \"pqdvsmBQ4XyM8p_GpBTf3w\",\n  \"type\": \"user\"\n}",
            "type": "JObject"
          }
        ]
      }
    ],
    "attachedContent": [
      {
        "spaceId": null,
        "contentId": "a525bc95-fafc-4112-97ed-c7c48bbfc02e"
      }
    ],
    "updateDiffs": [
      {
        "fieldName": "plannedStartDate",
        "before": null,
        "after": "2024-03-11T18:30:00.0000000+00:00"
      },
      {
        "fieldName": "plannedEndDate",
        "before": null,
        "after": "2024-03-20T18:30:00.0000000+00:00"
      },
      {
        "fieldName": "customProperty",
        "before": "[]",
        "after": "[{\"Id\":\"8DFDeqXPKk2ezl3L0iw_Lw\",\"MultipleValue\":false,\"Name\":\"justin-test-user123\",\"Values\":[{\"Id\":null,\"Value\":{\"id\":\"pqdvsmBQ4XyM8p_GpBTf3w\",\"type\":\"user\"}}]}]"
      }
    ]
  },
  "application": "EnablementPlannerService",
  "productArea": "EnablementPlanner"
}

📘Early Access

Webhook Payload

data object details

formRef object details

followers array object details

customProperties array object details

customProperties array object details

attachedContent array object details

updateDiffs array object details

Example

📘
Early Access