Versions Compared

Old Version 3

changes.mady.by.user Jay-Ar Brouillard

Saved on

compared with

New Version Current

changes.mady.by.user Avnish Patel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Common Event Fields

Each incoming event passes an event payload to the listener depending on the event type. Below are example payloads for each event type.

All Event messages have the following top level fields:

Key

Description

eventType

The event type that triggered this Event. e.g. Workflow Completed, Task Created.

actor

The actor, generally a user, that triggered this event.

object

The object the event occurred on. This could be the Project name, Release name etc.

timestamp

The time the event occurred.

payload

The specific event payload (see examples below)

Events

...

Comment Added

The Pipeline Stage Completed Comment Added event is triggered whenever a stage succeeds or fails in a Release Pipeline Execution. Common use cases can include logic you want to perform after EVERY pipeline execution regardless of the Pipeline or Release being used. For example you may want to create a Service Now incident whenever the Production Stage fails in any pipeline. This could be easily accomplished by listening for this event but filtering for a status of FAILED and environment of PRODUCTION.

...

titlePipeline Stage Completed

...

anytime there is a comment created throughout FlexDeploy. As and example use case, you could use this event to create a Jira Ticket anytime a comment was created and contained the words “Jira”.

Code Block
{
  "eventType": "Comment Added",
  "actor": "fdadmin",
  "object": "Comment - 1913",
  "timestamp": "2023-10-18 05:45:44 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-18 05:45:44 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-18 05:45:44 -0500",
    "commentId": 1913,
    "oldCommentText": null,
    "commentText": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"test4\"}]}]}",
    "objectId": 33313,
    "objectType": "WORK_ITEM"
  }
}

Comment Updated

The Comment Updated event is triggered anytime a comment is edited throughout FlexDeploy.

Code Block
{
  "eventType": "Comment Updated",
  "actor": "fdadmin",
  "object": "Comment - 1913",
  "timestamp": "2023-10-18 05:45:44 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-18 05:45:44 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-18 05:45:44 -0500",
    "commentId": 1913,
    "oldCommentText": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"test3\"}]}]}",
    "commentText": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"test4\"}]}]}",
    "objectId": 33313,
    "objectType": "WORK_ITEM"
  }
}

Comment Deleted

The Comment Updated event is triggered anytime a comment is deleted throughout FlexDeploy.

Code Block
{
  "eventType": "Comment Updated",
  "actor": "fdadmin",
  "object": "Comment - 1913",
  "timestamp": "2023-10-18 05:45:44 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-18 05:45:44 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-18 05:45:44 -0500",
    "commentId": 1913,
    "oldCommentText": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"test3\"}]}]}",
    "commentText": null,
    "objectId": 33313,
    "objectType": "WORK_ITEM"
  }
}

Package Created

The Package Created event is triggered anytime a package is created for a project throughout FlexDeploy. This could possibly be used as a event to execute a script to automatically add the package to a release whenever one is created for a specific project.

Code Block
{
  "eventType": "Package Created",
  "actor": "fdadmin",
  "object": "XXHR-10089",
  "timestamp": "2023-10-19 12:52:11 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-19 12:52:11 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:52:11 -0500",
    "projectPackageId": 1144126,
    "description": "\n",
    "excludePath": null,
    "includePath": null,
    "packageName": "XXHR-10089",
    "packagePath": null,
    "packageStatus": "ACTIVE",
    "packageType": "USER_MANAGED",
    "projectId": 195743,
    "tests": null,
    "testLevel": null,
    "versionSyntax": null,
    "project": {
      "projectId": 195743,
      "projectName": "XXHR"
    }
  }
}

Package Status Updated

@Since 7.0.0.1 - The Package Status Updated event is triggered anytime a package’s status is changed (‘Active’, ‘Inactive’, ‘Completed’) for a project throughout FlexDeploy. This could possibly be used as a event to execute a script to automatically remove the package from a release whenever it is inactivated or completed for a specific project.

Code Block
{
  "eventType": "Package Status Updated",
  "actor": "fdadmin",
  "object": "XXHR-10089",
  "timestamp": "2023-10-19 12:52:11 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-19 12:52:11 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:52:11 -0500",
    "projectPackageId": 1144126,
    "description": "\n",
    "excludePath": null,
    "includePath": null,
    "packageName": "XXHR-10089",
    "packagePath": null,
    "packageStatus": "ACTIVE",
    "packageType": "USER_MANAGED",
    "projectId": 195743,
    "tests": null,
    "testLevel": null,
    "versionSyntax": null,
    "project": {
      "projectId": 195743,
      "projectName": "XXHR"
    }
  }
}

Pipeline Stage Completed

The Pipeline Stage Completed event is triggered whenever a stage succeeds or fails in a Release Pipeline Execution. Common use cases can include logic you want to perform after EVERY pipeline execution regardless of the Pipeline or Release being used. For example you may want to create a Service Now incident whenever the Production Stage fails in any pipeline. This could be easily accomplished by listening for this event but filtering for a status of FAILED and environment of PRODUCTION.

Code Block
languagejson
{
    "eventType":"Pipeline Stage Completed",
    "actor":"buildmonitorworker",
    "object":"REST Release 1",
    "timestamp":"2020-12-16 15:12:41 -0500",
    "payload":{
        "pipelineExecutionId":null,
        "pipelineStageExecution":{
            "stageExecutionId":104516,
            "environmentId":11595,
            "executionStatus":"FAILED",
            "startTime":"2020-12-16 15:12:19 -0500",
            "endTime":"2020-12-16 15:12:41 -0500",
            "activeStep":null
        },
        "pipeline":{
            "pipelineId":10001,
            "pipelineName":"Simple"
        },
        "environment":{
            "environmentId":11595,
            "environmentName":"Dev",
            "environmentCode":"DEV"
        },
        "release":{
            "releaseId":11611,
            "releaseName":"REST Release 1"
        },
        "snapshot":{
            "snapshotId":104506,
            "snapshotName":"07-16-2020 15:12:18",
            "snapshotStatus":"INITIATED",
            "description":null,
            "releaseId":11611
        }
    }
}

Release Started

The Release Started event is triggered whenever a release is started in FlexDeploy. Common use cases can include logic you want to perform after any release is started. For example you may want to start a sprint in Jira whenever the release is started.

Code Block
languagejson
{
  "eventType": "Release Started",
  "actor": "avnish",
  "object": "Release Build 503",
  "timestamp": "2024-03-25 13:17:08 -0500",
  "payload": {
    "release": {
      "releaseId": 236634,
      "releaseName": "Release Build 503",
      "releaseDescription": "Blackout W test"
    },
    "startDate": 1711390628000,
    "endDate": null,
    "projects": [
      {
        "projectId": 10212437,
        "projectName": "XXHR",
        "packageName": "JavaPkg",
        "streamName": "master",
        "buildEnvironment": {
          "environmentId": 11595,
          "environmentName": "Dev123",
          "environmentCode": "DEV1"
        },
        "groupName": null
      },
      {
        "projectId": 19422906,
        "projectName": "Build 503",
        "packageName": null,
        "streamName": "master",
        "buildEnvironment": {
          "environmentId": 223477,
          "environmentName": "503 Build",
          "environmentCode": "503BUILD"
        },
        "groupName": null
      },
      {
        "projectId": 19667075,
        "projectName": "XXHR TFVC",
        "packageName": "Pkg1",
        "streamName": "master",
        "buildEnvironment": {
          "environmentId": 418564,
          "environmentName": "Development",
          "environmentCode": "DEV"
        },
        "groupName": null
      }
    ],
    "pipeline": {
      "pipelineId": 198497,
      "pipelineName": "Pipeline Check"
    }
  }
}

Release Ended

The Release Ended event is triggered whenever a release is endedin FlexDeploy. Common use cases can include logic you want to perform after any release is ended. For example you may want to end a sprint in Jira whenever the release is ended.

Code Block
languagejson
{
  "eventType": "Release Ended",
  "actor": "avnish",
  "object": "Release Build 503",
  "timestamp": "2024-03-25 13:19:00 -0500",
  "payload": {
    "release": {
      "releaseId": 236634,
      "releaseName": "Release Build 503",
      "releaseDescription": "Blackout W test"
    },
    "startDate": 1711390628000,
    "endDate": null,
    "projects": [
      {
        "projectId": 10212437,
        "projectName": "XXHR",
        "packageName": "JavaPkg",
        "streamName": "master",
        "buildEnvironment": {
          "environmentId": 11595,
          "environmentName": "Dev123",
          "environmentCode": "DEV1"
        },
        "groupName": null
      },
      {
        "projectId": 19422906,
        "projectName": "Build 503",
        "packageName": null,
        "streamName": "master",
        "buildEnvironment": {
          "environmentId": 223477,
          "environmentName": "503 Build",
          "environmentCode": "503BUILD"
        },
        "groupName": null
      },
      {
        "projectId": 19667075,
        "projectName": "XXHR TFVC",
        "packageName": "Pkg1",
        "streamName": "master",
        "buildEnvironment": {
          "environmentId": 418564,
          "environmentName": "Development",
          "environmentCode": "DEV"
        },
        "groupName": null
      }
    ],
    "pipeline": {
      "pipelineId": 198497,
      "pipelineName": "Pipeline Check"
    }
  }
}

Snapshot Completed

The Snapshot Completed event is triggered whenever a snapshot eventually completes successfully or fails to build.

Code Block
languagejson
{
    "eventType":"Snapshot Completed",
    "actor":"fdadmin",
    "object":"07-16-2020 15:58:59",
    "timestamp":null,
    "payload":{
        "createdBy":"fdadmin",
        "createdOn":"2020-58-16 15:58:57 -0500",
        "updatedBy":"completedsnapshotsmonitor",
        "updatedOn":"2020-59-16 15:59:13 -0500",
        "snapshot":{
            "snapshotId":104530,
            "snapshotName":"07-16-2020 15:58:59",
            "snapshotStatus":"INITIATED",
            "description":null,
            "releaseId":50157
        }
    }
}

Tag Assigned

The Tag Assigned event is triggered whenever a tag is assigned to an object like a project, environment, or target group.

Code Block
{
  "eventType": "Tag Assigned",
  "actor": "fdadmin",
  "object": "alpha",
  "timestamp": "2023-10-19 12:53:12 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-19 12:53:12 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:53:12 -0500",
    "tagAssignmentId": 135344,
    "tagId": 64158,
    "tag": {
      "tagId": 64158,
      "tagStyle": "{\"dark\":\"#949FDA\",\"light\":\"#3F51B5\"}",
      "tagKey": "alpha"
    },
    "objectId": 557168,
    "objectType": "TARGET_GROUP"
  }
}

Tag Unassigned

The Tag Unassigned event is triggered whenever a tag is unassigned from an object like a project, environment, or target group.

Code Block
{
  "eventType": "Tag Unassigned",
  "actor": "fdadmin",
  "object": "alpha",
  "timestamp": "2023-10-19 12:53:23 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-19 12:53:12 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:53:12 -0500",
    "tagAssignmentId": 135344,
    "tagId": 64158,
    "tag": {
      "tagId": 64158,
      "tagStyle": "{\"dark\":\"#949FDA\",\"light\":\"#3F51B5\"}",
      "tagKey": "alpha"
    },
    "objectId": 557168,
    "objectType": "TARGET_GROUP"
  }
}

Task Created

The Task Created event is triggered whenever a human task is created. This can be triggered from either a standalone project or a release.

Code Block
languagejson
{
    "eventType":"Task Created",
    "actor":"completedsnapshotsmonitor",
    "object":"Test Release",
    "timestamp":"2020-03-16 16:03:43 -0500",
    "payload":{
        "createdBy":"completedsnapshotsmonitor",
        "createdOn":"2020-03-16 16:03:43 -0500",
        "updatedBy":"completedsnapshotsmonitor",
        "updatedOn":"2020-03-16 16:03:43 -0500",
        "taskId":50702,
        "taskStatus":"PENDING",
        "externalId":null,
        "externalSystemId":null,
        "externalSystemType":null,
        "taskNotes":null,
        "groupId":10942,
        "roleId":11601,
        "environment":{
            "environmentId":11595,
            "environmentName":"Dev",
            "environmentCode":"DEV"
        },
        "release":{
            "releaseId":50157,
            "releaseName":"Test Release"
        },
        "pipelineExecution":{
            "pipelineId":54957,
            "pipelineExecutionId":104553,
            "executionStatus":"RUNNING",
            "activeStageExecution":{
                "stageExecutionId":104554,
                "environmentId":11595,
                "executionStatus":"RUNNING_GATES",
                "startTime":null,
                "endTime":null,
                "activeStep":{
                    "id":54961,
                    "executionId":104555,
                    "executionStatus":"PENDING_APPROVAL",
                    "isGate":true
                }
            }
        },
        "snapshotId":104549,
        "workflow":null,
        "workflowRequestId":null,
        "project":null
    }
}

Task Approved

The Task Approved event is triggered whenever a human approval task is approved.

Code Block
{
  "eventType": "Task Approved",
  "actor": "fdadmin",
  "object": "Sample Release",
  "timestamp": "2023-10-19 12:54:42 -0500",
  "payload": {
    "createdBy": "releaseeventprocessor",
    "createdOn": "2023-10-19 12:25:39 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:54:42 -0500",
    "taskId": 274103,
    "taskStatus": "APPROVED",
    "taskIdentifier": "a4591136-d24d-4144-9006-27262070dee7",
    "taskType": "APPROVAL",
    "externalId": null,
    "externalSystemId": null,
    "externalSystemType": null,
    "taskNotes": "",
    "groupId": 1,
    "roleId": 15901,
    "environment": {
      "environmentId": 10051,
      "environmentName": "Dev",
      "environmentCode": "DEV"
    },
    "release": {
      "releaseId": 703416,
      "releaseName": "Sample Release",
      "releaseDescription": null
    },
    "pipelineExecution": {
      "pipelineId": 702655,
      "pipelineExecutionId": 898155,
      "executionStatus": "
FAILED
RUNNING",
"startTime
"activeStageExecution":
"2020-12-16 15:12:19 -0500",
 {
"endTime":"2020-12-16 15:12:41 -0500"
"stageExecutionId": 898157,
        
"
activeStep
environmentId":
null
 10051,
}
"executionStatus": "RUNNING_GATES",
        "
pipeline
startTime":
{
 
null,
        
"
pipelineId
endTime":
10001, 
 null,
        "
pipelineName
activeStep":
"Simple" 
 {
},
         "
environment
id":
{
 
706075,
          "
environmentId
executionId":
11595
 898158,
          
"
environmentName
executionStatus": "
Dev
PENDING_APPROVAL",

          "
environmentCode
isGate":
"DEV"
 true
        }
,

      }
"release":{
   },
    "snapshotId": 898150,
    "
releaseId
workflow":
11611
 null,
    
"workflowRequestId": null,
    
"
releaseName
project":
"REST
Release
null
1"
  }
}

Task Rejected

The Task Rejected event is triggered whenever a human approval task is rejected.

Code Block
{
  "eventType": "Task
}
Rejected",
  
"actor": "fdadmin",
  "
snapshot
object":
{
 "Sample Release",
  "timestamp": "2023-10-19 
12:54:44 -0500",
  "
snapshotId
payload":
104506,
 {
    "createdBy": "releaseeventprocessor",
    
"
snapshotName
createdOn": "
07
2023-
16
10-
2020
19
15
12:
12:18", 
25:00 -0500",
    "
snapshotStatus
updatedBy": "
INITIATED
fdadmin",
    "updatedOn": "2023-10-19 12:54:44 -0500",
    "
description
taskId":
null
 274101,
    
"taskStatus": "REJECTED",
    "
releaseId
taskIdentifier":
11611 
 "774bc94f-12f5-46de-a0c3-907662745222",
} } }

Release Started

The Release Started event is triggered whenever a release is started in FlexDeploy. Common use cases can include logic you want to perform after any release is started. For example you may want to start a sprint in Jira whenever the release is started.

{
"taskType": "APPROVAL",
    "
eventType
externalId":
"Release
Started"
null,
    "
actor
externalSystemId":
"fdadmin"
 null,
    "externalSystemType": null,
    "
object
taskNotes": "
testRelease
",
    "
timestamp
groupId":
"2020-08-18 16:08:48 -0500"
 1,
    "roleId": 15901,
    "
payload
environment": {
      "environmentId": 10051,
"release":{ 
      "environmentName": "Dev",
      "environmentCode": "DEV"
    },
    "
releaseId
release":
54052,
 {
      
"releaseId": 703416,
      "releaseName": "
testRelease
Sample Release",
      "releaseDescription": null
    },
    "
releaseDescription
pipelineExecution":
null
 {
      "pipelineId":
}
702655,

      
"
startDate
pipelineExecutionId":
"2020-09-18"
 898141,
      "executionStatus": 
"
endDate
RUNNING"
:null
,

      
"
projects
activeStageExecution":
[
 {
        "stageExecutionId": 898143,
{
       "environmentId": 10051,
        "
projectId
executionStatus":
440135,
 "RUNNING_GATES",
        "startTime": null,
        "
projectName
endTime":
"partialFile"
 null,
        "activeStep": {
"streamName":"master",
      "id": 706075,
          "
buildEnvironment
executionId":
{
 898144,
          "executionStatus": "PENDING_APPROVAL",
          "
environmentId
isGate":
null,
 true
        }
      }
"environmentName":null
 },
    "snapshotId": 898134,
    
"workflow": null,
    
"
environmentCode
workflowRequestId": null,
    "project": null
  
}
}
Expand
titleRelease Started Payload
Code Block
languagejson

User Created

The User Created event is triggered whenever a user is created inside FlexDeploy. This could be particularly useful when configuring users in an Single Sign-On (SSO) Realm setup.

Code Block
{
  "eventType": "User
}
Created",
  "actor": "fdadmin",
  "object": "marge",
  "timestamp": "2023-10-19 12:57:41 -0500",
  "
groupName
payload":
null
 {
    "createdBy": "fdadmin",
} 
"createdOn": "2023-10-19 12:57:41 -0500",
], 
"updatedBy": "fdadmin",
    "
pipeline
updatedOn":
{
 
"2023-10-19 12:57:41 -0500",
    
"
pipelineId
userId":
17854
 29191963,
    
"email": "large.marge@gmail.com",
    "
pipelineName
firstName": "
DanPipeline
large",
} } }

Release Ended

The Release Ended event is triggered whenever a release is endedin FlexDeploy. Common use cases can include logic you want to perform after any release is ended. For example you may want to end a sprint in Jira whenever the release is ended.

{
"isActive": true,
    "
eventType
lastName":
"Release Ended"
 "marge",
    "localUser": true,
    "
actor
userName": "
fdadmin
marge",
    "
object
loginFailedAttempts":
"testRelease"
 null,
    "
timestamp
groups":
"2020-10-18 16:10:55 -0500"
 [
      {
        "groupId": 1,
        "
payload
groupName":
{
 "FD Administrators",
        "
release
description":
{
 "Admin Users",
        "isActive": true,
        "
releaseId
isAdminGroup":
54052,
 true
      }
    ],
    "
releaseName":"testRelease", 
extGroups": []
  }
}
Expand
titleRelease Ended Payload
Code Block
languagejson

Workflow Completed

The Workflow Completed event is triggered whenever a workflow execution succeeds or fails. Note that this event will trigger for ALL workflow types.

The testSuiteExec array in the payload will return all test suite executions from the workflow. This is most common in TEST workflows but tests can be run from any workflow type (Build, Deploy, Utility, etc..).

Workflow Completed (DEPLOY) Event Payload

Code Block
languagejson
{
    "
releaseDescription
eventType":
null }, 
"Workflow Completed",
    "
startDate
actor":"
2020-09-18
fdadmin",

    
"
endDate
object":
null
"currentStatusPartial",
    
"
projects
timestamp":
[ { 
"2020-23-14 14:23:39 -0500",
"projectId":440135, 
"payload":{
        "
projectName
createdBy":"
partialFile
fdadmin",
        "createdOn":"2020-23-14 14:23:25 -0500",
        "
streamName
updatedBy":"
master
fdadmin",
        "updatedOn":"2020-23-14 14:23:39 -0500",
        "
buildEnvironment
executionStatus":
{
"SUCCESS",
        "workflowExecutionId":12408,
        "startTime":"2020-23-14
"environmentId":null
14:23:25 -0500",
        "endTime":"2020-23-14 
14:23:39 -0500",
        "
environmentName
workflow":
null, 
{
            "
environmentCode
workflowId":
null
1130,
}, 
"workflowName":"SimpleDeployPartial",
            "
groupName
workflowType":
null
"DEPLOY",
}
"workflowVersionId":1131
]
},
        "
pipeline
project":{
            "
pipelineId
projectId":
17854
10002,
            "
pipelineName
projectName":"
DanPipeline
currentStatusPartial"
        },
} }

Snapshot Completed

The Snapshot Completed event is triggered whenever a snapshot eventually completes successfully or fails to build.

{
"projectVersionId":13101,
        "
eventType
projectVersionName":"
Snapshot Completed
1.0.37",
        "
actor
packageName": "
fdadmin
TestPackage",
        "
object
projectStreamId":
"07-16-2020 15:58:59"
10003,
"timestamp":null,
    
"
payload
projectStreamName":
{
"master",
        "
createdBy
instance":
"fdadmin",
{
            "
createdOn
instanceId":
"2020-58-16 15:58:57 -0500",
1168,
            "
updatedBy
instanceName":"
completedsnapshotsmonitor
Current Status",
            "
updatedOn
instanceCode":"
2020-59-16 15:59:13 -0500"
CURRENTSTATUS"
        },
        "
snapshot
environment":{
            "
snapshotId
environmentId":
104530
1166,
            "
snapshotName
environmentName":"
07-16-2020 15:58:59
Development",
            "
snapshotStatus
environmentCode":"
INITIATED",
DEV"
        },
        "
description
release":
null,
{
            "releaseId":
50157
null,
} } }
Expand
titleSnapshot Completed Payload
Code Block
languagejson

Task Created

The Task Created event is triggered whenever a human task is created. This can be triggered from either a standalone project/application or a release.

{
      "
eventType
releaseName":
"Task Created",
null
        },
        "
actor
snapshot":
"completedsnapshotsmonitor"
{
            "snapshotId":null,
"object":"Test Release",
        "snapshotName":null,
            "
timestamp
snapshotStatus":
"2020-03-16 16:03:43 -0500",
null,
            "
payload
description":
{
null,
            "
createdBy
releaseId":
"completedsnapshotsmonitor", 
null
"createdOn":"2020-03-16
16:03:43 -0500"
 },
        "
updatedBy
workflowRequest":
"completedsnapshotsmonitor",
{
            "
updatedOn
workflowRequestId":
"2020-03-16 16:03:43 -0500",
12505,
            "
taskId
forceDeploy":
50702
true,
            "
taskStatus
triggerType":"
PENDING
MANUAL",
            "
externalId
flexFields":
null,
[
"externalSystemId":
null,
"externalSystemType":null,
"taskNotes":
null,
"groupId":10942,
        null,
"roleId":11601,
"environment":{
    null,
"environmentId":11595,
        null,
"environmentName":"Dev",
"environmentCode":"DEV"
null,
},
     null,
"release":{
"releaseId":50157
null,
"releaseName":"Test Release" 
   null,
},
"pipelineExecution":{
null
"pipelineId":54957
],
            "
pipelineExecutionId
priority":
104553
1,
            "
executionStatus
allFilesRequested":
"RUNNING",
false
        },
        "
activeStageExecution
issueNumbers":
{
[
        ],
        "
stageExecutionId
cmsTickets":
104554,
[
        ],
        "
environmentId
testSuiteExec":
11595,
[
        ]
    }
}
Expand
titleTask Created Payload
Code Block

Workflow Completed (TEST) Event Payload

Code Block
languagejson
{
    "
executionStatus
eventType":"
RUNNING_GATES
Workflow Completed",
    "actor":"fdadmin",
    "object":"TestProject",
    "timestamp":"2020-44-18 10:44:16
"startTime":null,
-0500",
    "payload":{
        "createdBy":"fdadmin",
"endTime":null
"createdOn":"2020-43-18 10:43:57 -0500",
        "updatedBy":"fdadmin",
        "
activeStep
updatedOn":
{ 
"2020-44-18 10:44:16 -0500",
        "executionStatus":"SUCCESS",
        
"
id
workflowExecutionId":
54961
10409,
        "startTime":"2020-43-18 
10:43:58 -0500",
        "
executionId
endTime":
104555
"2020-44-18 10:44:16 -0500",
        "workflow":{
            "
executionStatus
workflowId":
"PENDING_APPROVAL"
1193,
     
       "workflowName":"TestWorkflow",
            
"
isGate
workflowType":
true
"TEST",
            "workflowVersionId":1195
}
     },
}
 "project":{
},
     "projectId":10002,
"snapshotId":104549,
         "
workflow
projectName":
null,
"TestProject"
"workflowRequestId":null
},
        "
project
projectVersionId":
null 
10010,
} }

Workflow Completed

The Workflow Completed event is triggered whenever a workflow execution succeeds or fails. Note that this event will trigger for ALL workflow types.

{
     "
eventType
projectVersionName":"
Workflow Completed
1.0.1",
        "
actor
projectStreamId":
"fdadmin",
10003,
        "
object
projectStreamName":"
currentStatusPartial
master",
        "
timestamp
instance":
"2020-23-14 14:23:39 -0500",
{
            "
payload
instanceId":
{
1323,
            "
createdBy
instanceName":"
fdadmin
Local",
            "
createdOn
instanceCode":"
2020-23-14 14:23:25 -0500",
LOCAL"
        },
        "environment":{
            "
updatedBy
environmentId":
"fdadmin",
1320,
            "
updatedOn
environmentName":
"2020-23-14 14:23:39 -0500",
"Development",
            "
executionStatus
environmentCode":"
SUCCESS"
DEV"
        },
        "
workflowExecutionId
release":
12408
null,
        "
startTime
snapshot":
"2020-23-14 14:23:25 -0500"
null,
        "
endTime
workflowRequest":
"2020-23-14 14:23:39 -0500",
{
            "
workflow
workflowRequestId":
{
10411,
            "
workflowId
forceDeploy":
1130
false,
            "
workflowName
triggerType":"
SimpleDeployPartial
MANUAL",
            "
workflowType
flexFields":
"DEPLOY",
[
"workflowVersionId":1131
  null,
},
"project":{
 null,
"projectId":10002,
     null,
"projectName":"currentStatusPartial"
}
null,
"projectVersionId":13101,
"projectVersionName":"1.0.37",
null,
"packageName":
"TestPackage",
      null,
"projectStreamId":10003,
"projectStreamName":"master",
     null,
"instance":{
"instanceId":1168
null,
"instanceName":"Current Status"
    null,
"instanceCode":"CURRENTSTATUS"
    null
},
        ],
"environment":{
            
"
environmentId
priority":
1166
null,
            "
environmentName
allFilesRequested":
"Development",
false
        },
        "
environmentCode
issueNumbers":
"DEV"
[
}
],
        "
release
cmsTickets":
{
[
        ],
        "
releaseId
testSuiteExec":
null,
[
"releaseName":null
{
}, 
        "
snapshot
testSuiteExecutionId":
{
1262620,
                "
snapshotId
status":
null,
"FAILED",
                "
snapshotName
startTime":
null, 
"2023-06-12 11:33:37 -0500",
"snapshotStatus":null,
       "endTime":"2023-06-12 11:34:13 -0500",
"description":null,
             "
releaseId
testExecutions":
null
[
},
"workflowRequest":
{
"workflowRequestId":12505, 
            "
forceDeploy
name":
true
"LocalPostmanTest1",
"triggerType":"MANUAL",
             "
flexFields
status":
[
"FAILED",
null,
null
"toolName":"Postman",
null,
        "testResults":[
null,
null,
   
{
null,
null,
    "testCaseName":"http://numbergen.com:8000/JavaRandomNumGenApp/random-number",
null,
null,
   "status":"FAILED",
null
],
      "message":"Status code is 200 - AssertionFailure -
"priority
null"
:1
,
"allFilesRequested":false
},
         "
issueNumbers
minResponseTime":
[
null,
],
"cmsTickets":[
],
         "
testRun
maxResponseTime":null,
} }{
"eventType":"Workflow
Completed",
"actor":"fdadmin",
     "
object
avgResponseTime":
"TestProject",
null,
"timestamp":"2020-44-18
10:44:16
-0500",
"payload":{
"createdBy":"fdadmin",
         "
createdOn
duration":
"2020-43-18 10:43:57 -0500",
0,
"updatedBy":"fdadmin",
"updatedOn":"2020-44-18 10:44:16 -0500",
            "
executionStatus
executionCount":
"SUCCESS",
1,
"workflowExecutionId":10409,
"startTime":"2020-43-18
10:43:58
-0500",
         "
endTime
outputData":
"2020-44-18 10:44:16 -0500",
null
"workflow":{
"workflowId":1193,
  }
"workflowName":"TestWorkflow",
"workflowType":"TEST", 
 ]
"workflowVersionId":1195
         }
,
,
"project":
{
"projectId":10002,
             "
projectName
name":"
TestProject
LocalPostmanTest2",
},
"projectVersionId":10010,
         "
projectVersionName
status":"
1.0.1
FAILED",
"projectStreamId":10003,
"projectStreamName":"master",
       
"
instance
toolName":
{
"Postman",
"instanceId":1323,
             "
instanceName
testResults":
"Local",
[
"instanceCode":"LOCAL"
},
  {
"environment":{
"environmentId":1320,
"environmentName":"Development
"testCaseName":"http://numbergen.com:8000/JavaRandomNumGenApp/random-number",
"environmentCode":"DEV"
},
         "
release
status":
null
"FAILED",
"snapshot":null,
"workflowRequest":{
             "
workflowRequestId
message":
10411,
"Status code is 200 - AssertionFailure - null",
"forceDeploy":false,
"triggerType":"MANUAL",
             "
flexFields
minResponseTime":
[
null,
null,
                
"maxResponseTime":null,
null,
                
"avgResponseTime":null,
null,
null
"duration":0,
null,
null,
"executionCount":1,
null,
              "outputData":null
null
],
"priority":null
},
"allFilesRequested":false
},
"issueNumbers":[
],
"cmsTickets":[
{
],
"testRun":{
             "
runId
name":
10102,
"ParameterizedTest",
"runStatus":"PASSED",
               "
startTime
status":"
2020-43-18 10:43:58 -0500",
PASSED",
"endTime":"2020-44-18
10:44:16
-0500",
             "
testSets":[
toolName":"JUnit",
{
             "testResults":[
"name":"Test
Set
1",
"status":"PASSED",
    {
"testTypeId":10001,
                      "
testTypeName
testCaseName":"
Unit Tests
my.company.tests.ParameterizedTest.testMultiplication[0]",
"testDefinitions":[
                 "status":"PASSED",
{
                             "
name
message":
"Test Def 1", 
null,
"status":"PASSED",
             "minResponseTime":null,
"testingTool":"Postman",
                               "
endpointId
maxResponseTime":
10001,
null,
                                      "
results
avgResponseTime":
[
null,
{
  "duration":3,
"testCaseName":"GetProjects-
Status
code
is
200
"executionCount":1,
                                      "
status
outputData":
"PASSED",
null
"message":null
},
                                  {
"maxResponseTime":null,
                                     "
duration
testCaseName":
2999,
"my.company.tests.ParameterizedTest.testMultiplication[1]",
                                      "
executionCount
status":
1
"PASSED",
                                      "message":null,
},
{
  "minResponseTime":null,
"testCaseName":"GetProject-
Status
code
is
200
"maxResponseTime":null,
                                      "
status
avgResponseTime":
"PASSED"
null,
                                      "
message
duration":
null
0,
                                      "
maxResponseTime
executionCount":
null
1,
                                      "
duration
outputData":
509,
null
                                  }
"executionCount":1
                             ]
}
                       }
]
                   ]
}
               }
]
           ]
}
       }
]
}
]
    }
}
Expand
titleWorkflow Completed (DEPLOY) Event Payload
Code Block
languagejson
Expand
titleWorkflow Completed (TEST) Event Payload
Code Block
languagejson

Work Item Created

The Work Item Created event is triggered whenever a work item is created.

Expandcode
titleWork Item Created Event Payload
Code Block
languagejson
{
    "eventType":"Work Item Created",
    "actor":"fdadmin",
    "object":"5903",
    "timestamp":"2023-05-26 18:19:38 -0500",
    "payload":{
        "createdBy":"fdadmin",
        "createdOn":"2023-05-26 18:19:38 -0500",
        "updatedBy":"fdadmin",
        "updatedOn":"2023-05-26 18:19:38 -0500",
        "flxWorkItemId":5903,
        "workItemNumber":"5903",
        "title":"POSTMAN_Test_FlxWorkItem_2",
        "description":"POSTMAN test FlxWorkitem 2",
        "type":{
            "name":"12345678901234567890123456789012345678901234567890",
            "code":"12345678901234567890123456789012345678901234567890"
        },
        "status":{
            "id":1,
            "name":"TODO"
        },
        "assignee":{
            "id":1,
            "userName":"fdadmin",
            "email":"erick.jones@flexagon.com"
        },
        "tags":null,
        "customFields":[
        ],
        "workItemUpdates":null
    }
}

Work Item Updated

The Work Item Updated event is triggered whenever work item is updated.

code
Expandcode
titleWork Item Updated Event Payload
languagejson
{
    "eventType":"Work Item Updated",
    "actor":"fdadmin",
    "object":"5901",
    "timestamp":"2023-05-26 18:19:40 -0500",
    "payload":{
        "createdBy":"fdadmin",
        "createdOn":"2023-05-26 18:19:37 -0500",
        "updatedBy":"fdadmin",
        "updatedOn":"2023-05-26 18:19:40 -0500",
        "flxWorkItemId":5901,
        "workItemNumber":"5901",
        "title":"POSTMAN_Test_FlxWorkItem_1",
        "description":"Updated POSTMAN test FlxWorkitem 1",
        "type":{
            "name":"12345678901234567890123456789012345678901234567890",
            "code":"12345678901234567890123456789012345678901234567890"
        },
        "status":{
            "id":1,
            "name":"TODO"
        },
        "assignee":{
            "id":1,
            "userName":"fdadmin",
            "email":"erick.jones@flexagon.com"
        },
        "tags":null,
        "customFields":[
            {
                "fieldName":"PRIORITY",
                "fieldValue":"Priority2"
            },
            {
                "fieldName":"KARLS8519",
                "fieldValue":null
            },
            {
                "fieldName":"MORE_AND_MORE",
                "fieldValue":null
            },
            {
                "fieldName":"SDFSDF",
                "fieldValue":null
            },
            {
                "fieldName":"FIELD6",
                "fieldValue":null
            },
            {
                "fieldName":"VENDOR_NOT_FOUND",
                "fieldValue":"false"
            }
        ],
        "workItemUpdates":[
            {
                "fieldName":"Description",
                "newValue":"Updated POSTMAN test FlxWorkitem 1",
                "oldValue":"POSTMAN test FlxWorkitem 1"
            }
        ]
    }
}