Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titlePipeline Stage Completed
Code Block
{
    "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 Snapshot Completed Release Started event is triggered whenever a snapshot eventually completes successfully or fails to buildrelease 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.

Expand
titleSnapshot Completed Release Started Payload
Code Block
languagejson
{
    "eventType":"SnapshotRelease CompletedStarted",
    "actor":"fdadmin",
    "object":"07-16-2020 15:58:59testRelease",
    "timestamp":null"2020-08-18 16:08:48 -0500",
    "payload":{
        "createdByrelease":"fdadmin",{
            "createdOnreleaseId":"2020-58-16 15:58:57 -0500",54052,
            "updatedByreleaseName":"completedsnapshotsmonitortestRelease",
            "updatedOnreleaseDescription":"2020-59-16 15:59:13 -0500"null
        },
        "snapshotstartDate":{"2020-09-18",
            "snapshotIdendDate":104530null,
         "projects":[
  "snapshotName":"07-16-2020 15:58:59",         {
   "snapshotStatus":"INITIATED",             "descriptionprojectId":null440135,
            "releaseId":50157
        }
    }
}

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.

Expand
titleTask Created Payload
Code Block
{
    "eventType":"Task Created",
    "actor":"completedsnapshotsmonitor",
    "object":"Test Release",
    "timestamp":"2020-03-16 16:03:43 -0500",
    "payload":{    "projectName":"partialFile",
                "streamName":"master",
                "buildEnvironment":{
                    "environmentId":null,
                    "environmentName":null,
                    "environmentCode":null
                },
                "groupName":null
            }
        ],
        "pipeline":{
            "pipelineId":17854,
            "pipelineName":"DanPipeline"
        }
    }
}

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 enda sprint in Jira whenever the release is ended.

Expand
titleRelease Ended Payload
Code Block
languagejson
{
    "eventType":"Release Ended",
    "actor":"fdadmin",
    "object":"testRelease",
    "timestamp":"2020-10-18 16:10:55 -0500",
    "payload":{
        "release":{
            "releaseId":54052,
            "releaseName":"testRelease",
            "releaseDescription":null
        },
        "startDate":"2020-09-18",
        "endDate":null,
        "projects":[
            {
                "projectId":440135,
                "projectName":"partialFile",
                "streamName":"master",
                "buildEnvironment":{
                    "environmentId":null,
                    "environmentName":null,
                    "environmentCode":null
                },
                "groupName":null
            }
        ],
        "pipeline":{
            "pipelineId":17854,
            "pipelineName":"DanPipeline"
        }
    }
}

Snapshot Completed

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

Expand
titleSnapshot Completed Payload
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
        }
    }
}

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.

Expand
titleTask Created Payload
Code Block
{
    "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
    }
}

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.

Expand
titleWorkflow Completed (DEPLOY) Event Payload
Code Block
languagejson
{
    "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
        },
        "snapshot":{
            "snapshotId":null,
            "snapshotName":null,
            "snapshotStatus":null,
            "description":null,
            "releaseId":null
        },
        "workflowRequest":{
            "workflowRequestId":12505,
            "forceDeploy":true,
            "triggerType":"MANUAL",
            "flexFields":[
                null,
                null,
                null,
                null,
                null,
                null,
                null,
                null,
                null,
                null
            ],
            "priority":1,
            "allFilesRequested":false
        },
        "issueNumbers":[
        ],
        "cmsTickets":[
        ],
        "testRun":null
    }
}

Expand
titleWorkflow Completed (TEST) Event Payload
Code Block
languagejson
{
    "eventType":"Workflow Completed",
    "actor":"fdadmin",
    "object":"TestProject",
    "timestamp":"2020-44-18 10:44:16 -0500",
    "payload":{
        "createdBy":"fdadmin",
        "createdOn":"2020-43-18 10:43:57 -0500",
        "updatedBy":"fdadmin",
        "updatedOn":"2020-44-18 10:44:16 -0500",
        "executionStatus":"SUCCESS",
        "workflowExecutionId":10409,
        "startTime":"2020-43-18 10:43:58 -0500",
        "endTime":"2020-44-18 10:44:16 -0500",
        "workflow":{
            "workflowId":1193,
            "workflowName":"TestWorkflow",
            "workflowType":"TEST",
            "workflowVersionId":1195
        },
        "project":{
            "projectId":10002,
            "projectName":"TestProject"
        },
        "projectVersionId":10010,
        "projectVersionName":"1.0.1",
        "projectStreamId":10003,
        "projectStreamName":"master",
        "instance":{
            "instanceId":1323,
            "instanceName":"Local",
            "instanceCode":"LOCAL"
        },
        "environment":{
            "environmentId":1320,
            "environmentName":"Development",
            "environmentCode":"DEV"
        "createdBy":"completedsnapshotsmonitor"},
        "createdOnrelease":"2020-03-16 16:03:43 -0500"null,
        "snapshot":null,
        "updatedByworkflowRequest":"completedsnapshotsmonitor",{
            "updatedOnworkflowRequestId":"2020-03-16 16:03:43 -0500",10411,
            "taskIdforceDeploy":50702false,
            "taskStatustriggerType":"PENDINGMANUAL",
            "externalIdflexFields":null,[
                "externalSystemId":null,
        "externalSystemType":null,
        "taskNotes":null,
        "groupId":10942,        null,
     "roleId":11601,         "environment":{  null,
          "environmentId":11595,      null,
      "environmentName":"Dev",          null,
  "environmentCode":"DEV"         },     null,
   "release":{             "releaseId":50157,null,
              "releaseName":"Test Release" null,
       },         "pipelineExecution":{null
            "pipelineId":54957],
            "pipelineExecutionIdpriority":104553null,
            "executionStatusallFilesRequested":"RUNNING",false
        },
        "activeStageExecutionissueNumbers":{[
        ],
        "stageExecutionIdcmsTickets":104554,[
        ],
       "environmentId":11595,     "testRun":{
            "executionStatusrunId":"RUNNING_GATES",
  10102,
             "startTimerunStatus":null"PASSED",
 
              "endTimestartTime":null,
 "2020-43-18 10:43:58 -0500",
              "activeStependTime":{
     "2020-44-18 10:44:16 -0500",
              "idtestSets":54961,[
                    "executionId":104555,{
                    "executionStatusname":"PENDING_APPROVALTest Set 1",
                    "isGatestatus":true"PASSED",
                }      "testTypeId":10001,
      }         },         "snapshotIdtestTypeName":104549,
   "Unit Tests",
    "workflow":null,         "workflowRequestId":null,         "projecttestDefinitions":null[
    }
}

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.

Expand
titleWorkflow Completed Event Payload
Code Block
languagejson
{     "eventType":"Workflow Completed",     "actor":"fdadmin",        "object":"currentStatusPartial",
 {
   "timestamp":"2020-23-14 14:23:39 -0500",     "payload":{         "createdBy":"fdadmin",         "createdOnname":"2020-23-14 14:23:25 -0500Test Def 1",
        "updatedBy":"fdadmin",            "updatedOn":"2020-23-14 14:23:39 -0500",         "executionStatusstatus":"SUCCESSPASSED",
        "workflowExecutionId":12408,         "startTime":"2020-23-14 14:23:25 -0500",         "endTimetestingTool":"2020-23-14 14:23:39 -0500Postman",
         "workflow":{                   "workflowIdendpointId":113010001,
               "workflowName":"SimpleDeployPartial",             "workflowTyperesults":"DEPLOY",[
              "workflowVersionId":1131         },         "project":{{
                    "projectId":10002,                "projectNametestCaseName":"currentStatusPartial"
        },GetProjects- Status code is 200",
         "projectVersionId":13101,         "projectVersionName":"1.0.37",         "projectStreamId":10003,         "projectStreamNamestatus":"masterPASSED",
        "instance":{               "instanceId":1168,             "instanceNamemessage":"Current Status",
    null,
       "instanceCode":"CURRENTSTATUS"         },         "environment":{             "environmentIdmaxResponseTime":1166null,
            "environmentName":"Development",               "environmentCode":"DEV"         },"duration":2999,
          "release":{             "releaseId":null,             "releaseNameexecutionCount":null1
          },         "snapshot":{             "snapshotId":null},
            "snapshotName":null,             "snapshotStatus":null,       {
     "description":null,             "releaseId":null         },         "workflowRequesttestCaseName":{"GetProject- Status code is 200",
          "workflowRequestId":12505,             "forceDeploy":true,             "triggerTypestatus":"MANUALPASSED",
                "flexFields":[                    "message":null,
                null,                    "maxResponseTime":null,
                null,                    null"duration":509,
                 null,                 null,  "executionCount":1
              null,                 null, }
               null             ],
                 "priority":1,       }
     "allFilesRequested":false         },      ]
  "issueNumbers":[         ],     }
   "cmsTickets":[         ],
        "testRun":null}
    }
}