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.

...

language	json

...

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

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":"fdadmin",
    "object":"testRelease",
    "timestamp":"2020-08-18 16:08:48 -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"
        }
    }
}

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

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",
    "actorcreatedOn":"buildmonitorworker "2023-10-19 12:53:12 -0500",
    "objectupdatedBy": "REST Release 1fdadmin",
    "timestampupdatedOn": "20202023-1210-1619 1512:53:12:41 -0500",
    "payloadtagAssignmentId":{ 135344,
    "tagId": 64158,
    "pipelineExecutionIdtag":null,  {
      "pipelineStageExecutiontagId":{ 64158,
        "tagStyle": "{\"dark\":\"#949FDA\",\"light\":\"#3F51B5\"}",
      "stageExecutionIdtagKey":104516, "alpha"
      },
    "environmentIdobjectId":11595 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

{
  "executionStatuseventType": "FAILEDTag Unassigned",
      "actor": "fdadmin",
     "startTimeobject":"2020-12-16 15:12:19 -0500",
          "alpha",
  "endTimetimestamp": "20202023-1210-1619 1512:1253:4123 -0500",
       "payload": {
    "activeStepcreatedBy":null "fdadmin",
    "createdOn": "2023-10-19  }12:53:12 -0500",
        "pipeline":{"updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:53:12 -0500",
    "pipelineIdtagAssignmentId":10001 135344,
       "tagId": 64158,
    "pipelineNametag":"Simple"
        },
  {
      "environmenttagId":{ 64158,
           "environmentId":11595,
    "tagStyle": "{\"dark\":\"#949FDA\",\"light\":\"#3F51B5\"}",
       "environmentNametagKey": "Devalpha",
    },
       "environmentCodeobjectId":"DEV" 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

{
       "releaseeventType":{
       "Task Created",
    "releaseIdactor":11611"completedsnapshotsmonitor",
       "object":"Test Release",
    "releaseNametimestamp":"REST Release 1"2020-03-16 16:03:43 -0500",
        },"payload":{
        "snapshotcreatedBy":{
   "completedsnapshotsmonitor",
        "snapshotIdcreatedOn":104506,
 "2020-03-16 16:03:43 -0500",
          "snapshotNameupdatedBy":"07-16-2020 15:12:18completedsnapshotsmonitor",

           "snapshotStatusupdatedOn":"INITIATED2020-03-16 16:03:43 -0500",

           "descriptiontaskId":null50702,
   
        "releaseIdtaskStatus":11611"PENDING",
        }
    }
}

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

{"externalId":null,
        "eventTypeexternalSystemId":"Release Started",null,
        "actorexternalSystemType":"fdadmin"null,
        "objecttaskNotes":"testRelease",null,
        "timestampgroupId":"2020-08-18 16:08:48 -0500",10942,
        "payloadroleId":{11601,
        "releaseenvironment":{
            "releaseIdenvironmentId":5405211595,
            "releaseNameenvironmentName":"testReleaseDev",
            "releaseDescriptionenvironmentCode":null"DEV"
        },
        "startDaterelease":"2020-09-18",{
            "endDatereleaseId":null50157,
            "projectsreleaseName":["Test Release"
        },
    {    "pipelineExecution":{
            "projectIdpipelineId":44013554957,
   
            "projectNamepipelineExecutionId":"partialFile"104553,
 
              "streamNameexecutionStatus":"masterRUNNING",

               "buildEnvironmentactiveStageExecution":{
 
                  "environmentIdstageExecutionId":null104554,

                   "environmentNameenvironmentId":null11595,
                    "environmentCodeexecutionStatus":null"RUNNING_GATES",
                }"startTime":null,
                "groupNameendTime":null
    ,
       }         ],
        "pipeline"activeStep":{
            "pipelineId":17854,
            "pipelineNameid":"DanPipeline"54961,
         }     } }

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

{     "eventTypeexecutionId":"Release Ended",104555,
          "actor":"fdadmin",     "object":"testRelease",     "timestampexecutionStatus":"2020-10-18 16:10:55 -0500PENDING_APPROVAL",
    "payload":{         "release":{         "isGate":true
   "releaseId":54052,             "releaseName":"testRelease",}
            "releaseDescription":null}
        },
        "startDatesnapshotId":"2020-09-18"104549,
        "endDateworkflow":null,
        "projectsworkflowRequestId":[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",
  "projectIdtimestamp":440135,
   "2023-10-19 12:54:42 -0500",
        "payload": {
    "projectNamecreatedBy": "partialFilereleaseeventprocessor",
    "createdOn": "2023-10-19 12:25:39 -0500",
        "streamNameupdatedBy": "masterfdadmin",
    "updatedOn": "2023-10-19 12:54:42 -0500",
    "taskId": 274103,
    "buildEnvironmenttaskStatus":{ "APPROVED",
        "taskIdentifier": "a4591136-d24d-4144-9006-27262070dee7",
    "taskType": "APPROVAL",
    "environmentIdexternalId": null,
               "externalSystemId": null,
    "environmentNameexternalSystemType": null,
    "taskNotes": "",
         "groupId": 1,
    "environmentCoderoleId":null 15901,
    "environment": {
         }"environmentId": 10051,
         "environmentName": "Dev",
      "groupNameenvironmentCode":null "DEV"
    },
    "release": {
}         ]"releaseId": 703416,
        "pipeline":{    "releaseName": "Sample Release",
      "pipelineIdreleaseDescription":17854, null
    },
      "pipelineNamepipelineExecution":"DanPipeline" {
       }"pipelineId": 702655,
    } }

Snapshot Completed

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

Code Block

language	json

{
    "eventTypepipelineExecutionId":"Snapshot Completed"898155,
      "actorexecutionStatus": "fdadminRUNNING",
      "objectactiveStageExecution":"07-16-2020 15:58:59", {
        "timestampstageExecutionId":null, 898157,
        "payloadenvironmentId":{ 10051,
        "createdByexecutionStatus": "fdadminRUNNING_GATES",
        "createdOnstartTime":"2020-58-16 15:58:57 -0500" null,
        "updatedByendTime":"completedsnapshotsmonitor" null,
        "updatedOnactiveStep":"2020-59-16 15:59:13 -0500", {
          "snapshotid":{  706075,
          "snapshotIdexecutionId":104530 898158,
 
          "snapshotNameexecutionStatus":"07-16-2020 15:58:59",
  "PENDING_APPROVAL",
          "snapshotStatus":"INITIATED",isGate": true
        }
      }
    },
    "descriptionsnapshotId":null 898150,
    "workflow": null,
      "releaseIdworkflowRequestId":50157 null,
       }"project": null
    }
}

Task

...

Rejected

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

Code Block

language	json

{
 {
  "eventType": "Task Rejected",
  "actor": "fdadmin",
  "eventTypeobject": "Sample Release",
  "timestamp":"Task Created "2023-10-19 12:54:44 -0500",
    "actorpayload":"completedsnapshotsmonitor", {
    "objectcreatedBy": "Test Releasereleaseeventprocessor",
    "timestampcreatedOn": "20202023-0310-1619 1612:0325:4300 -0500",
    "payloadupdatedBy":{
        "createdBy":"completedsnapshotsmonitorfdadmin",
        "createdOnupdatedOn": "20202023-0310-1619 1612:0354:4344 -0500",
    "taskId": 274101,
    "updatedBytaskStatus": "completedsnapshotsmonitorREJECTED",
        "updatedOntaskIdentifier": "2020-03-16 16:03:43 -0500",774bc94f-12f5-46de-a0c3-907662745222",
    "taskType": "APPROVAL",
    "externalId": null,
    "taskIdexternalSystemId":50702 null,
    "externalSystemType": null,
    "taskStatustaskNotes": "PENDING",
    "groupId": 1,
    "externalIdroleId":null,
  15901,
    "environment": {
      "externalSystemIdenvironmentId":null 10051,
       "environmentName": "externalSystemTypeDev":null,
       "environmentCode": "taskNotesDEV":null,
    },
    "groupIdrelease":10942,  {
      "roleIdreleaseId":11601 703416,
 
      "environmentreleaseName":{
 "Sample Release",
      "releaseDescription": null
   "environmentId":11595 },
    "pipelineExecution": {
      "environmentNamepipelineId":"Dev" 702655,
      "pipelineExecutionId": 898141,
      "environmentCodeexecutionStatus": "DEVRUNNING",
        },"activeStageExecution": {
        "releasestageExecutionId":{   898143,
         "releaseIdenvironmentId":50157 10051,

           "releaseNameexecutionStatus": "Test Release"RUNNING_GATES",
        "startTime": }null,
        "pipelineExecutionendTime":{    null,
        "pipelineIdactiveStep":54957,  {
          "pipelineExecutionIdid":104553 706075,
 
          "executionStatusexecutionId":"RUNNING" 898144,

           "activeStageExecutionexecutionStatus":{
    "PENDING_APPROVAL",
            "stageExecutionIdisGate":104554, true
        }
      "environmentId":11595,}
    },
    "snapshotId": 898134,
     "executionStatusworkflow":"RUNNING_GATES" null,
    "workflowRequestId": null,
    "project": null
  }
 "startTime":null,
                "endTime":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",
    "activeStepcreatedOn":{ "2023-10-19 12:57:41 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-19 12:57:41 -0500",
    "iduserId":54961 29191963,
         "email": "large.marge@gmail.com",
    "firstName": "large",
    "executionIdisActive":104555 true,
    "lastName": "marge",
         "localUser": true,
    "executionStatususerName": "PENDING_APPROVALmarge",
             "loginFailedAttempts": null,
      "isGategroups":true [
      {
         }"groupId": 1,
        "groupName": "FD Administrators",
 }       "description": "Admin }Users",
        "snapshotIdisActive":104549 true,
        "workflowisAdminGroup":null, true
      }
"workflowRequestId":null,    ],
    "projectextGroups":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.

...

Versions Compared

Old Version 7

New Version 8

Key

Events

Comment Added

Comment Updated

Comment Deleted

Package Created

Pipeline Stage Completed

Release Started

Release Ended

Snapshot Completed

Tag Assigned

Tag Unassigned

Task Created

Release Started

Release Ended

Task Approved

Snapshot Completed

Task

Rejected

User Created

Workflow Completed

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Events

Comment Added

Comment Updated

Comment Deleted

Package Created

Pipeline Stage Completed

Release Started

Release Ended

Snapshot Completed

Tag Assigned

Tag Unassigned

Task Created

Release Started

Release Ended

Task Approved

Snapshot Completed

Task

Rejected

User Created

Workflow Completed