WorkflowApproveStepV1

Occurs when a workflow step is approved.

Webhook Payload

The webhook event is encapsulated within a common wrapper structure providing general information about the event.

Property	Type	Description
id	string	The unique identifier for the event
version	string	The version of the event
occurredAt	string	The time the event occured
tenantId	string	The unique identifier for the tenant
tenantName	string	The name of the tenant
data	object	The container of the event details data object details
application	string	Application
productArea	string	Product Area

data object details

Property	Type	Description
userId	string	The unique identifier for the user
targetSource	string	The source of the target, value is one of 'Engagement' / 'ContentManager'
targetInfo	object	The information about the target targetInfo object details
workflowId	string	The unique identifier for the workflow
workflowName	string	The name of the workflow
workflowStepId	string	The unique identifier for the workflow step
stepName	string	The name of the workflow step
comments	string	Optional free‑text comment entered by the user when performing this workflow step (for example, when approving, rejecting, or revoking the step). This value is recorded at the step level and may be used by external systems (such as PEN) to display approver feedback to end users
nextWorkflowStepId	string	The unique identifier for the next workflow step if there is any
nextWorkflowStepName	string	The name of the next workflow step if there is any
selectedNextApprover	string	The selected approver for the next workflow step

targetInfo object details

Property	Type	Description
teamSiteId	string	The unique identifier for the team site
contentId	string	The unique identifier for the content
contentVersionId	string	The unique identifier for the content version

Example

{
  "id": "GUID",
  "version": "WorkflowApproveStepV1",
  "occurredAt": "2023-01-20T21:13:25.268Z",
  "tenantId": "b4d8bb18-dc97-4e18-8049-50a04edf453f",
  "tenantName": "fsdev",
  "data": {
    "userId": "36032adf-2435-485a-870f-b75520c0b6da",
    "targetSource": "ContentManager/Engagement",
    "targetInfo": {
      "teamSiteId": "47e52009-1ac8-4b89-bacc-3a2268725fb8",
      "contentId": "7ea7db16-a0de-4990-a6a6-206c5d958811",
      "contentVersionId": "7ea7db16-a0de-4990-a6a6-206c5d958811"
    },
    "workflowId": "7ea7db16-a0de-4990-a6a6-206c5d958811",
    "workflowName": "workflow 1",
    "workflowStepId": "7ea7db16-a0de-4990-a6a6-206c5d958811",
    "stepName": "step 1",
    "comments": "comments for approving this step",
    "nextWorkflowStepId": "36032adf-2435-485a-870f-b75520c0b6da",
    "nextWorkflowStepName": "step 2",
    "selectedNextApprover": "36032adf-2435-485a-870f-b75520c0b6da"
  },
  "application": "Workflow",
  "productArea": "MarketingExperience"
}