ProgramUpdateV1

Occurs when a program 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.

PropertyTypeDescription
idstringUnique event id
versionstringEvent version
occurredAtstringTimestamp of the event
tenantIdstringTenant unique id (GUID)
tenantNamestringTenant name
applicationstringApplication
productAreastringProduct area
dataobjectThe container of the event details data object details

data object details

PropertyTypeDescription
tenantIdstringThe unique identifier of the tenant
tenantNamestringTenant name
actorIdstringUser id of the actor
eventTimestampintegerTimestamp of the event
programIdstringProgram id
titlestringTitle of the program
descriptionstringDescription of the program
plannedStartDateintegerPlanned start date of the program
plannedEndDateintegerPlanned end date of the program
plannedDurationintegerPlanned duration in days of the program
creatorIdstringUser id of the program creator
createdAtintegerThe timestamp of the creation of the program
customPropertiesarray of objectsCustom properties of the program customProperties array object details
attachedContentarray of objectsAttached content attachedContent array object details
attachedRequestsarray of objectsAttached requests attachedRequests array object details
attachedTasksarray of objectsAttached tasks attachedTasks array object details
managerIdstringUser id of the program manager
isTemplatebooleanIndicator on if the program is a template or not
updatedAtintegerTimestamp of the last update of the program
actualDurationintegerCalculated actual duration in days of the program
actualStartDateintegerCalculated start date from when the program actually started
actualEndDateintegerCalculated end date from when the program actually ended
copyFromstringProgram id the Program is copied from
followersarray of objectsFollowers followers array object details
spaceIdstringSpace id
templateIdstringTemplate id the program was created from
updateDiffsarray of objectsThe list of field updates updateDiffs array object details
analyticSettingobjectProgram analytic setting analyticSetting object details

customProperties array object details

PropertyTypeDescription
idstringThe unique identifier of the custom property
multipleValuebooleanIndicate if the custom property allows multiple values
namestringThe name of the custom property
customPropertiesarray of objectsList of custom property values customProperties array object details

customProperties array object details

PropertyTypeDescription
idstringThe unique identifier of the custom property value
valuestringValue data for custom property value
typestringThe type of the custom property value

attachedContent array object details

PropertyTypeDescription
spaceIdstringSpace id
contentIdstringContent id

attachedRequests array object details

PropertyTypeDescription
spaceIdstringSpace id
requestIdstringRequest id

attachedTasks array object details

PropertyTypeDescription
spaceIdstringSpace id
taskIdstringTask id

followers array object details

PropertyTypeDescription
userIdstringUser id

updateDiffs array object details

PropertyTypeDescription
fieldNamestringThe name of the field
beforestringThe field value before the update
afterstringThe field value after the update

analyticSetting object details

PropertyTypeDescription
archivedbooleanArchived flag
enabledbooleanEnabled flag
launchDatenullProgram launch date
audiencearray of objectsProgram audience audience array object details
trackersarrayProgram trackers
topicsnullProgram topics
programTypestringProgram type
onboardingGroupstringOnboarding group
outcomeKpiFirststringFirst outcome program API
outcomeKpiSecondstringSecond outcome program API
outcomeKpiThirdstringThird outcome program API
metricObjectivesarray of objectsProgram success metrics metricObjectives array object details

audience array object details

PropertyTypeDescription
typestringAudience type
idstringAudience id

metricObjectives array object details

PropertyTypeDescription
metricTypestringMetric objective type
targetValue['string', 'null']Metric objective target value
measuredIn['string', 'null']Metric objective unit
trend['string', 'null']Metric objective trend
dateRange['string', 'null']Metric objective calculation date range
isHideFromOverView['boolean', 'null']Metric objective is hidden from overview

Example

{
  "id": "672138721224AC73424E45F14D65882AA81A2EDBDAD0B77FB5BEB474A461F6A7",
  "version": "ProgramUpdateV1",
  "occurredAt": "2024-03-31T10:00:34.682Z",
  "tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
  "tenantName": "demo",
  "application": "Program",
  "productArea": "Program",
  "data": {
    "tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
    "tenantName": "demo",
    "actorId": "ec216cc8-f0f0-4255-8774-84515739173b",
    "eventTimestamp": 638258925093150000,
    "programId": "FCLHNseThkq-b9i6GgRJyQ",
    "title": "Program Title",
    "description": "Program Description",
    "plannedStartDate": 638248176000000000,
    "plannedEndDate": 638248176000000000,
    "plannedDuration": 19,
    "creatorId": "b2a57fc8-ab79-8516-6a3f-e401b6c7c13c",
    "createdAt": 638258356057920000,
    "customProperties": [
      {
        "id": "a6dbbeaf-81b9-486a-9147-d0ac0c8524fb",
        "multipleValue": false,
        "name": "text ",
        "customProperties": [
          {
            "id": "",
            "value": "test",
            "type": "string"
          }
        ]
      },
      {
        "id": "9c2a72e0-3359-4558-ae1a-020268713d09",
        "multipleValue": false,
        "name": "task-date",
        "customProperties": [
          {
            "id": "",
            "value": "2023-07-01T07:00:00.0000000+00:00",
            "type": "DateTime"
          }
        ]
      },
      {
        "id": "166d2e9a-25a9-4d3c-b0e2-bf4ee7f9625d",
        "multipleValue": false,
        "name": "Stakeholder copy",
        "customProperties": [
          {
            "id": "",
            "value": "{\n  \"id\": \"ys6Sdu2U06UzncSvthK5wQ\",\n  \"type\": \"user\"\n}",
            "type": "JObject"
          }
        ]
      },
      {
        "id": "093d6d88-41cf-4300-82a8-aba39c592f8e",
        "multipleValue": false,
        "name": "Amet illum tempore voluptatem animi aut dolores et quidem dolor.",
        "customProperties": [
          {
            "id": "",
            "value": "X",
            "type": "string"
          }
        ]
      },
      {
        "id": "d4215fc9-9ddd-48c9-881e-490369a6d54e",
        "multipleValue": false,
        "name": "CL single select",
        "customProperties": [
          {
            "id": "248abb05-fa09-4cbe-ae59-37e47a139168",
            "value": "2",
            "type": "string"
          }
        ]
      }
    ],
    "attachedContent": [
      {
        "spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
        "contentId": "304a53b9-3f59-4e0d-ac53-a6fd925f4785"
      },
      {
        "spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
        "contentId": "c09db5c9-f2f4-4a03-a7f6-7980590b368e"
      }
    ],
    "attachedRequests": [
      {
        "spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
        "requestId": "790ae008-8aa8-47cb-9727-743a2ee1135e"
      },
      {
        "spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
        "requestId": "e0cd5ae3-f159-4b14-a9fa-7830aeb69c7b"
      }
    ],
    "attachedTasks": [
      {
        "spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
        "taskId": "d4f13e72-0087-4212-a72d-f7fe73c44dd2"
      },
      {
        "spaceId": "0bfe6a3e-d3dc-4881-a42e-515b1139e795",
        "taskId": "c596cb97-56af-46bf-820d-757718e2c6bd"
      }
    ],
    "managerId": "120fcca4-29d3-4999-8499-59754fc81a0e",
    "isTemplate": false,
    "updatedAt": 638258925093150000,
    "actualDuration": 19,
    "actualStartDate": 638248176000000000,
    "actualEndDate": 638263728000000000,
    "copyFrom": "vRmjoSLTV0GRtcvkjyiINw",
    "followers": [
      {
        "userId": "120fcca4-29d3-4999-8499-59754fc81a0e"
      }
    ],
    "spaceId": "ZX4Fik9-Aka8mU0qzX_sRQ",
    "templateId": "-FtOQVQ8aUySNf1R2Olq0g",
    "updateDiffs": [
      {
        "fieldName": "customProperty",
        "before": "[{\"Id\":\"pT_6NijNp02EnTOoZ5qJ8A\",\"MultipleValue\":false,\"Name\":\"justin-test-1031\",\"Values\":[{\"Id\":\"JbPjzxdVQkeUfi_kXlCWIQ\",\"Value\":333}]}]",
        "after": "[{\"Id\":\"pT_6NijNp02EnTOoZ5qJ8A\",\"MultipleValue\":false,\"Name\":\"justin-test-1031\",\"Values\":[{\"Id\":\"kziMXdzjXk61GJL0aIrHog\",\"Value\":111}]}]"
      }
    ],
    "analyticSetting": {
      "archived": false,
      "enabled": true,
      "launchDate": null,
      "audience": [
        {
          "type": "group",
          "id": "YRmMmtxlL9HzXX-yfnGXjA"
        }
      ],
      "trackers": [],
      "topics": null,
      "programType": "SalesPlay",
      "onboardingGroup": "Seller",
      "outcomeKpiFirst": "InfluencedRevenue",
      "outcomeKpiSecond": "WonOpportunities",
      "outcomeKpiThird": "ThirdDealAverageCloseTime",
      "metricObjectives": [
        {
          "metricType": "PageViews",
          "targetValue": null,
          "measuredIn": "Number",
          "trend": "Increasing",
          "dateRange": null,
          "isHideFromOverView": false
        },
        {
          "metricType": "ContentViews",
          "targetValue": null,
          "measuredIn": "Number",
          "trend": "Increasing",
          "dateRange": null,
          "isHideFromOverView": false
        }
      ]
    }
  }
}