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.

...

title	Pipeline 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

language	json

{
    "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

language	json

{
  "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

language	json

{
  "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

language	json

{
    "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

language	json

{
    "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": "RUNNING",
      "activeStageExecution": {
        "stageExecutionId": 898157,
        "environmentId": 10051,
        "executionStatus": "RUNNING_GATES",
        "startTime": null,
        "endTime": null,
        "activeStep": {
          "id": 706075,
          "executionId": 898158,
          "executionStatus": "PENDING_APPROVAL",
          "isGate": true
        }
      }
    },
    "snapshotId": 898150,
    "workflow": null,
    "workflowRequestId": null,
    "project": null
  }
}

Task Rejected

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

Code Block

{
  "eventType": "Task Rejected",
  "actor": "fdadmin",
  "object": "Sample Release",
  "timestamp": "2023-10-19 12:54:44 -0500",
  "payload": {
    "createdBy": "releaseeventprocessor",
    "createdOn": "2023-10-19 12:25:00 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:54:44 -0500",
    "taskId": 274101,
    "taskStatus": "REJECTED",
    "taskIdentifier": "774bc94f-12f5-46de-a0c3-907662745222",
    "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": 898141,
      "executionStatus": "RUNNING",
      "activeStageExecution": {
        "stageExecutionId": 898143,
        "environmentId": 10051,
        "executionStatus": "RUNNING_GATES",
        "startTime": null,
        "endTime": null,
        "activeStep": {
          "id": 706075,
          "executionId": 898144,
          "executionStatus": "PENDING_APPROVAL",
          "isGate": true
        }
      }
    },
    "snapshotId": 898134,
    "workflow": null,
    "workflowRequestId": null,
    "project": null
  }
}

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",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-19 12:57:41 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:57:41 -0500",
    "userId": 29191963,
    "email": "large.marge@gmail.com",
    "firstName": "large",
    "isActive": true,
    "lastName": "marge",
    "localUser": true,
    "userName": "marge",
    "loginFailedAttempts": null,
    "groups": [
      {
        "groupId": 1,
        "groupName": "FD Administrators",
        "description": "Admin Users",
        "isActive": true,
        "isAdminGroup": true
      }
    ],
    "extGroups": []
  }
}

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

language	json

{
    "eventType":"Workflow Completed",
    "actor":"fdadmin",
    "object":"currentStatusPartial",
    "timestamp":"2020-23-14 14:23:39 -0500",
    "payload":{
        "createdBy":"fdadmin",
        "createdOn":"2020-23-14 14:23:25 -0500",
        "updatedBy":"fdadmin",
        "updatedOn":"2020-23-14 14:23:39 -0500",
        "executionStatus":"SUCCESS",
        "workflowExecutionId":12408,
        "startTime":"2020-23-14 14:23:25 -0500",
        "endTime":"2020-23-14 14:23:39 -0500",
        "workflow":{
            "workflowId":1130,
            "workflowName":"SimpleDeployPartial",
            "workflowType":"DEPLOY",
            "workflowVersionId":1131
        },
        "project":{
            "projectId":10002,
            "projectName":"currentStatusPartial"
        },
        "projectVersionId":13101,
        "projectVersionName":"1.0.37",
        "packageName": "TestPackage",
        "projectStreamId":10003,
        "projectStreamName":"master",
        "instance":{
            "instanceId":1168,
            "instanceName":"Current Status",
            "instanceCode":"CURRENTSTATUS"
        },
        "environment":{
            "environmentId":1166,
            "environmentName":"Development",
            "environmentCode":"DEV"
        },
        "release":{
            "releaseId":null,
            "releaseName":null
        },
        "

pipelineExecutionId

snapshot":

null,

{
            "

pipelineStageExecution

snapshotId":

{

null,
            "

stageExecutionId

snapshotName":

104516

null,
            "

environmentId

snapshotStatus":

11595

null,
            "

executionStatus

description":

"FAILED"

null,
            "

startTime

releaseId":

"2020-12-16 15:12:19 -0500",

null
        },
        "

endTime

workflowRequest":

"2020-12-16 15:12:41 -0500",

activeStep

workflowRequestId":

null

12505,

},

"forceDeploy":true,
            "

pipeline

triggerType":

{

"MANUAL",
            "

pipelineId

flexFields":

10001,

"pipelineName":"Simple"

null,

},

     null,

"environment":{

"environmentId":11595

null,

"environmentName":"Dev",

    null,

"environmentCode":"DEV"

}

null,

"release":{

        null,

"releaseId":11611,

"releaseName":"REST Release 1"

null,

},

     null,

"snapshot":{

"snapshotId":104506,

null,

"snapshotName":"07-16-2020 15:12:18",

 null

"snapshotStatus":"INITIATED"

],
            "

description

priority":

null

1,
            "

releaseId

allFilesRequested":

11611

false
        },

}

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.

{

eventType

issueNumbers":

"Release Started",

"actor":"fdadmin",

],
        "

object

cmsTickets":

"testRelease",

"timestamp":"2020-08-18

16:08:48 -0500",

 ],
        "

payload

testSuiteExec":

{

"release":{

]
    }
}

Expand

title	Release Started Payload

Code Block

language	json

Workflow Completed (TEST) Event Payload

Code Block

language	json

releaseId

eventType":

54052

"Workflow Completed",

"actor":"fdadmin",
    "

releaseName

object":"

testRelease

TestProject",
    "timestamp":"2020-44-18

10:44:16 -0500",
    "

releaseDescription

payload":

null

}

"createdBy":"fdadmin",
        "

startDate

createdOn":"2020-

09

43-18 10:43:57 -0500",
        "

endDate

updatedBy":

null

"fdadmin",
        "

projects

updatedOn":

[

"2020-44-18 10:44:16 -0500",

{

"executionStatus":"SUCCESS",
        "

projectId

workflowExecutionId":

440135,

10409,
        "

projectName

startTime":"

partialFile",

2020-43-18 10:43:58 -0500",
        "

streamName

endTime":"

master

2020-44-18 10:44:16 -0500",

"buildEnvironment

"workflow":{

"environmentId

"workflowId":

null

1193,

environmentName

workflowName":

null

"TestWorkflow",

"environmentCode":null

"workflowType":"TEST",
            "workflowVersionId":1195

},

},
        "

groupName

project":

null

}

"projectId":10002,

],

     "projectName":"TestProject"

"pipeline":{

     },
        "

pipelineId

projectVersionId":

17854

10010,

pipelineName

projectVersionName":"

DanPipeline

1.0.1",

}

"projectStreamId":10003,

} }

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.

{

"projectStreamName":"master",
        "

eventType

instance":

"Release Ended",

{
            "

actor

instanceId":

"fdadmin"

1323,

"object

        "instanceName":"

testRelease

Local",
            "

timestamp

instanceCode":

"2020-10-18 16:10:55 -0500",

"LOCAL"

"payload":{

},
        "

release

environment":{
            "

releaseId

environmentId":

54052

1320,
            "

releaseName

environmentName":"

testRelease

Development",
            "

releaseDescription

environmentCode":

null

"DEV"
        },

}

"release":null,
        "

startDate

snapshot":

"2020-09-18"

null,
        "

endDate

workflowRequest":

null,

"projects":[

    "workflowRequestId":10411,

{

    "forceDeploy":false,
            "

projectId

triggerType":

440135

"MANUAL",
            "flexFields":[

"projectName":"partialFile",

             null,

"streamName":"master",

            null,

"buildEnvironment":{

            null,

"environmentId":null,

        null,

"environmentName":null,

    null,

"environmentCode":

null,

}

null,

"groupName":null

null,

}

 null,

],

"pipeline":{

null

"pipelineId":17854

],
            "

pipelineName

priority":

"DanPipeline"

null,

}

    "allFilesRequested":false

} }

Expand

title	Release Ended Payload

Code Block

language	json

Snapshot Completed

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

{

"eventType":"Snapshot Completed"

},

"actor":"fdadmin",

object

issueNumbers":

"07-16-2020 15:58:59",

"timestamp":null,

],
        "

payload

cmsTickets":

{

"createdBy":"fdadmin"

],
        "

createdOn

testSuiteExec":

"2020-58-16 15:58:57 -0500",

"updatedBy":"completedsnapshotsmonitor",

"updatedOn":"2020-59-16 15:59:13

-0500",

snapshot

testSuiteExecutionId":

{

1262620,
                "

snapshotId

status":

104530

"FAILED",
                "

snapshotName

startTime":"

07

2023-

16

06-

2020

15:58:59",

11:33:37 -0500",
                "

snapshotStatus

endTime":"

INITIATED

2023-06-12 11:34:13 -0500",
                "

description

testExecutions":

null,

"releaseId":50157

}

Expand

title	Snapshot Completed Payload

Code Block

language	json

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":"Task

Created",

"actor":"completedsnapshotsmonitor",

object

name":"

Test Release

LocalPostmanTest1",

"timestamp":"2020-03-16 16:03:43 -0500",

"payload":{

createdBy

status":"

completedsnapshotsmonitor

FAILED",

"createdOn":"2020-03-16 16:03:43 -0500",

updatedBy

toolName":"

completedsnapshotsmonitor

Postman",

"updatedOn":"2020-03-16 16:03:43 -0500",

taskId

testResults":

50702,

"taskStatus":"PENDING",

"externalId":null,

"externalSystemId":null,

"externalSystemType":null,

"taskNotes":null,

"groupId":10942,

         "testCaseName"

roleId

:"

:11601

http://numbergen.com:8000/JavaRandomNumGenApp/random-number",

"environment":{

"environmentId":11595,

environmentName

status":"

Dev

FAILED",

"environmentCode":"DEV"

},

release

message":

{

"Status code is 200 - AssertionFailure

"releaseId":50157,

- null",

"releaseName":"Test

Release"

},

pipelineExecution

minResponseTime":

{

null,

"pipelineId":54957,

"pipelineExecutionId":104553,

executionStatus

maxResponseTime":

"RUNNING",

null,

"activeStageExecution":{

stageExecutionId

avgResponseTime":

104554

null,

"environmentId":11595,

executionStatus

duration":

"RUNNING_GATES"

0,

"startTime":null,

endTime

executionCount":

null

1,

"activeStep":{

            "outputData":null

"id":54961,

"executionId":104555,

"executionStatus":"PENDING_APPROVAL",

"isGate":true

},

}

},

snapshotId

name":

104549

"LocalPostmanTest2",

"workflow":null,

workflowRequestId

status":

null

"FAILED",

"project":null

}

Expand

title	Task Created Payload

Code Block

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":"Workflow

Completed",

actor

toolName":"

fdadmin

Postman",

"object":"currentStatusPartial",

"timestamp":"2020-23-14

14:23:39 -0500",

"payload":{

createdBy

testResults":

"fdadmin",

"createdOn":"2020-23-14

14:23:25

-0500",

"updatedBy":"fdadmin",

"updatedOn":"2020-23-14

14:23:39

-0500",

"executionStatus":"SUCCESS",

"workflowExecutionId":12408,

startTime

testCaseName":"

2020-23-14 14:23:25 -0500

http://numbergen.com:8000/JavaRandomNumGenApp/random-number",

"endTime":"2020-23-14

14:23:39

-0500",

"workflow":{

workflowId

status":

1130

"FAILED",

"workflowName":"SimpleDeployPartial",

"workflowType":"DEPLOY",

      "message":"Status code is 200 - AssertionFailure -

"workflowVersionId":1131

null",

},

"project":{

projectId

minResponseTime":

10002

null,

"projectName":"currentStatusPartial"

},

projectVersionId

maxResponseTime":

13101

null,

"projectVersionName":"1.0.37",

"packageName":

"TestPackage",

"projectStreamId":10003,

projectStreamName

avgResponseTime":

"master"

null,

"instance":{

"instanceId":1168,

instanceName

duration":

"Current Status",

0,

"instanceCode":"CURRENTSTATUS"

},

environment

executionCount":

{

1,

"environmentId":1166,

environmentName

outputData":

"Development",

null

"environmentCode":"DEV"

},

},

"release":{

"releaseId":null,

"releaseName":null

},

"snapshot":{

"snapshotId":null,

"snapshotName":null,

        "name":"ParameterizedTest",

"snapshotStatus":null,

"description":null,

releaseId

status":

null

"PASSED",

},

"workflowRequest":{

workflowRequestId

toolName":

12505,

"JUnit",

"forceDeploy":true,

triggerType

testResults":

"MANUAL",

"flexFields":[

null,

       "testCaseName":"my.company.tests.ParameterizedTest.testMultiplication[0]",

null,

            "status":"PASSED",

null,

                 "message":null,

null,

                      "minResponseTime":null,

],

"priority":1,

allFilesRequested

maxResponseTime":

false

null,

},

"issueNumbers":[

],

cmsTickets

avgResponseTime":

[

null,

],

"testRun":null

}

}{

"eventType":"Workflow

Completed",

"actor":"fdadmin",

object

duration":

"TestProject", "timestamp":"2020-44-18 10:44:16 -0500",

3,

"payload":{

"createdBy":"fdadmin",

"createdOn":"2020-43-18 10:43:57 -0500",

updatedBy

executionCount":

"fdadmin"

1,

"updatedOn":"2020-44-18 10:44:16 -0500",

"executionStatus":"SUCCESS",

"workflowExecutionId":10409,

startTime

outputData":

"2020-43-18 10:43:58 -0500",

null

"endTime":"2020-44-18

10:44:16

-0500",

"workflow":{

"workflowId":1193

},

"workflowName":"TestWorkflow",

"workflowType":"TEST",

"workflowVersionId":1195

},

"project":{

projectId

testCaseName":

10002

"my.company.tests.ParameterizedTest.testMultiplication[1]",

"projectName":"TestProject"

},

"projectVersionId":10010,

projectVersionName

status":"

1.0.1

PASSED",

"projectStreamId":10003,

"projectStreamName":"master",

instance

message":

{

null,

"instanceId":1323,

"instanceName":"Local",

instanceCode

minResponseTime":

"LOCAL"

null,

},

"environment":{

"environmentId":1320,

environmentName

maxResponseTime":

"Development"

null,

"environmentCode":"DEV"

},

"release":null,

snapshot

avgResponseTime":null,

"workflowRequest":{

"workflowRequestId":10411,

forceDeploy

duration":

false

0,

"triggerType":"MANUAL",

"flexFields":[

null

"executionCount":1,

null,

       "outputData":null

null,

null

],

"priority":null,

"allFilesRequested":false

},

"issueNumbers":[

}
        ]

,

}
}

Expand

title	Workflow Completed (DEPLOY) Event Payload

Code Block

language	json

Expand

title	Workflow Completed (TEST) Event Payload

Code Block

language	json

Work Item Created

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

Code Block

language	json

{
    "

cmsTickets

eventType":

[

"Work Item Created",
    "actor":"fdadmin",

],

"object":"5903",
    "

testRun

timestamp":

{

"2023-05-26 18:19:38 -0500",

"runId

"payload":

10102,

runStatus

createdBy":"

PASSED

fdadmin",

startTime

createdOn":"

2020

2023-

43

05-26 18

10

43

19:

58

38 -0500",
        "updatedBy":"fdadmin",
        "

endTime

updatedOn":"

2020

2023-

44

05-26 18

10

44

19:

16

38 -0500",

testSets

flxWorkItemId":

[

5903,

{

"workItemNumber":"5903",
        "title":"POSTMAN_Test_FlxWorkItem_2",

name

description":"

Test

POSTMAN test

Set

FlxWorkitem

1

2",
        "type":{
            "

status

name":"

PASSED

12345678901234567890123456789012345678901234567890",
            "code":"12345678901234567890123456789012345678901234567890"

"testTypeId":10001

 },
        "status":{
            "

testTypeName

id":

"Unit Tests"

1,

"name":"TODO"

"testDefinitions":[

     },
        "assignee":{

{

  "id":1,

"userName":"fdadmin",
            "

name

email":"

Test Def 1",

erick.jones@flexagon.com"
        },

"tags":null,
        "

status

customFields":

"PASSED",

[
        ],
        "workItemUpdates":null
    }
}

Work Item Updated

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

Code Block

language	json

{
    "eventType":"Work Item Updated",
    "

testingTool

actor":"

Postman

fdadmin",
    "object":"5901",
    "timestamp":"2023-05-26 18:19:40 -0500",

"payload":{

endpointId

createdBy":

10001

"fdadmin",
        "createdOn":"2023-05-26 18:19:37 -0500",
        "updatedBy":"fdadmin",
        "

results

updatedOn":

[

"2023-05-26 18:19:40 -0500",
        "flxWorkItemId":5901,
        "workItemNumber":"5901",

{

"title":"POSTMAN_Test_FlxWorkItem_1",
        "description":"Updated POSTMAN test FlxWorkitem 1",
        "type":{

testCaseName

name":"

GetProjects- Status code is 200

12345678901234567890123456789012345678901234567890",
            "code":"12345678901234567890123456789012345678901234567890"

},

"status":

"PASSED",

{
            "id":1,
            "name":"TODO"

"message":null

},
        "assignee":{
            "id":1,

maxResponseTime

userName":

null,

"fdadmin",
            "email":"erick.jones@flexagon.com"
        },
        "tags":null,
        "

duration

customFields":

2999,

[
            {

"executionCount":1

"fieldName":"PRIORITY",
                "fieldValue":"Priority2"
            },

},

          {
                "fieldName":"KARLS8519",

{

           "fieldValue":null
            },

"testCaseName":"GetProject- Status code is 200",

{
                "fieldName":"MORE_AND_MORE",
                "fieldValue":null

"status":"PASSED",

       },
            {
                "

message

fieldName":

null,

"SDFSDF",
                "fieldValue":null
            },

"maxResponseTime":null,

   {
                "fieldName":"FIELD6",
                "

duration

fieldValue":

509,

null
            },
            {

"executionCount":1

      "fieldName":"VENDOR_NOT_FOUND",
                "fieldValue":"false"

}

   }
        ],
        "workItemUpdates":[

]

     {
                "fieldName":"Description",

}

              "newValue":"Updated POSTMAN test FlxWorkitem 1",

]

              "oldValue":"POSTMAN test FlxWorkitem

}

1"

]

}

]
    }
}

Versions Compared

Old Version 2

New Version Current

Key

Common Event Fields

Events

Comment Added

Comment Updated

Comment Deleted

Package Created

Package Status Updated

Pipeline Stage Completed

Release Started

Release Ended

Snapshot Completed

Tag Assigned

Tag Unassigned

Task Created

Task Approved

Task Rejected

User Created

Workflow Completed

Workflow Completed (DEPLOY) Event Payload

Release Started

Workflow Completed (TEST) Event Payload

Release Ended

Snapshot Completed

Task Created

Workflow Completed

Work Item Created

Work Item Updated

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Common Event Fields

Events

Comment Added

Comment Updated

Comment Deleted

Package Created

Package Status Updated

Pipeline Stage Completed

Release Started

Release Ended

Snapshot Completed

Tag Assigned

Tag Unassigned

Task Created

Task Approved

Task Rejected

User Created

Workflow Completed

Workflow Completed (DEPLOY) Event Payload

Release Started

Workflow Completed (TEST) Event Payload

Release Ended

Snapshot Completed

Task Created

Workflow Completed

Work Item Created

Work Item Updated