Versions Compared

Old Version 5

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.

...

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.

...

languagejson

...

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",
            "pipelineExecutionIddescription":null,
            "pipelineStageExecutionreleaseId":{50157
        }
    "stageExecutionId":104516,
         }
}

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",
  "environmentIdtimestamp":11595,
   "2023-10-19 12:53:12 -0500",
   "payload": {
    "executionStatuscreatedBy": "FAILEDfdadmin",

           "startTime"createdOn": "20202023-1210-1619 1512:53:12:19 -0500",
       "updatedBy": "fdadmin",
    "endTimeupdatedOn": "20202023-1210-1619 1512:53:12:41 -0500",
    "tagAssignmentId": 135344,
      "activeSteptagId":null 64158,
       },
 "tag": {
      "pipelinetagId":{ 64158,
           "pipelineId":10001,
"tagStyle": "{\"dark\":\"#949FDA\",\"light\":\"#3F51B5\"}",
           "pipelineNametagKey": "Simplealpha"
    },
   }, "objectId": 557168,
      "environmentobjectType":{ "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",
  "environmentIdactor":11595 "fdadmin",
  "object": "alpha",
  "timestamp": "2023-10-19 12:53:23 -0500",
  "environmentNamepayload":"Dev", {
           "environmentCode"createdBy": "DEVfdadmin",
    "createdOn": "2023-10-19   },
   12:53:12 -0500",
    "releaseupdatedBy":{  "fdadmin",
          "releaseId"updatedOn":11611,
      "2023-10-19 12:53:12 -0500",
      "releaseNametagAssignmentId":"REST Release135344,
1"    "tagId": 64158,
   }, "tag": {
      "snapshottagId":{    64158,
        "snapshotId":104506"tagStyle": "{\"dark\":\"#949FDA\",\"light\":\"#3F51B5\"}",
      "tagKey": "alpha"
    "snapshotName":"07-16-2020 15:12:18"},
       "objectId": 557168,
    "snapshotStatusobjectType": "INITIATEDTARGET_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
{
    "descriptioneventType":null"Task Created",
       "actor":"completedsnapshotsmonitor",
    "releaseIdobject":11611"Test Release",
    "timestamp":"2020-03-16   }16:03:43 -0500",
    }
}

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
{"payload":{
        "eventTypecreatedBy":"Release Startedcompletedsnapshotsmonitor",
        "actorcreatedOn":"fdadmin2020-03-16 16:03:43 -0500",
        "objectupdatedBy":"testReleasecompletedsnapshotsmonitor",
        "timestampupdatedOn":"2020-0803-1816 16:0803:4843 -0500",
        "payloadtaskId":{50702,
        "releasetaskStatus":{
 "PENDING",
          "releaseIdexternalId":54052null,

           "releaseNameexternalSystemId":"testRelease",
   null,
        "releaseDescriptionexternalSystemType":null,
        }"taskNotes":null,
        "startDategroupId":"2020-09-18"10942,
        "endDateroleId":null11601,
        "projectsenvironment":[{
            {"environmentId":11595,
                "projectIdenvironmentName":440135"Dev",
                "projectNameenvironmentCode":"partialFileDEV",
        },
        "streamNamerelease":"master",{
            "releaseId":50157,
            "buildEnvironmentreleaseName":{"Test Release"
        },
          "environmentIdpipelineExecution":null,{
            "pipelineId":54957,
            "environmentNamepipelineExecutionId":null104553,
            "executionStatus":"RUNNING",
            "environmentCodeactiveStageExecution":null{
                }"stageExecutionId":104554,
                "groupNameenvironmentId":null11595,
            }    "executionStatus":"RUNNING_GATES",
      ],          "pipelinestartTime":{null,
                "pipelineIdendTime":17854null,
                "pipelineNameactiveStep":"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
languagejson
{"id":54961,
         "eventType":"Release Ended",     "actor":"fdadmin",     "objectexecutionId":"testRelease"104555,
    "timestamp":"2020-10-18 16:10:55 -0500",     "payload":{         "releaseexecutionStatus":{"PENDING_APPROVAL",
                    "releaseIdisGate":54052,true
                "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",
  "projectIdobject":440135, "Sample Release",
  "timestamp": "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,
    "externalSystemType": null,
       "taskNotes": "environmentName":null,
    "groupId": 1,
         "roleId": 15901,
    "environmentCodeenvironment":null {
      "environmentId": 10051,
       }"environmentName": "Dev",
      "environmentCode": "DEV"
    },
    "groupNamerelease":null {
      "releaseId": 703416,
   }   "releaseName":      ],
"Sample Release",
       "pipelinereleaseDescription":{ null
    },
      "pipelineIdpipelineExecution":17854,
      {
      "pipelineNamepipelineId":"DanPipeline" 702655,
       }
    }
}

Snapshot Completed

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

Code Block
languagejson
{"pipelineExecutionId": 898155,
      "eventTypeexecutionStatus": "Snapshot CompletedRUNNING",
      "actoractiveStageExecution":"fdadmin" {
        "stageExecutionId": 898157,
        "objectenvironmentId":"07-16-2020 15:58:59", 10051,
        "timestampexecutionStatus":null, "RUNNING_GATES",
        "payloadstartTime":{ null,
        "createdByendTime":"fdadmin" null,
        "createdOnactiveStep":"2020-58-16 15:58:57 -0500", {
          "updatedByid":"completedsnapshotsmonitor", 706075,
          "executionId": 898158,
          "updatedOnexecutionStatus":"2020-59-16 15:59:13 -0500", "PENDING_APPROVAL",
          "snapshotisGate":{ true
        }
  "snapshotId":104530,    }
    },
    "snapshotNamesnapshotId":"07-16-2020 15:58:59" 898150,
       "workflow": null,
    "snapshotStatusworkflowRequestId":"INITIATED" null,
    "project": null
  }
}

Task Rejected

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

Code Block
{
  "descriptioneventType":null,      "Task Rejected",
  "actor": "fdadmin",
  "releaseIdobject":50157 "Sample Release",
  "timestamp": "2023-10-19 12:54:44 -0500",
}     }
}

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.

Code Block
languagejson
"payload": {
    "eventTypecreatedBy": "Task Createdreleaseeventprocessor",
    "actorcreatedOn":"completedsnapshotsmonitor "2023-10-19 12:25:00 -0500",
    "objectupdatedBy": "Test Releasefdadmin",
    "timestampupdatedOn": "20202023-0310-1619 1612:0354:4344 -0500",
    "payloadtaskId":{ 274101,
       "createdBytaskStatus": "completedsnapshotsmonitorREJECTED",
   
    "createdOntaskIdentifier": "2020-03-16 16:03:43 -0500774bc94f-12f5-46de-a0c3-907662745222",
    "taskType": "APPROVAL",
    "externalId": null,
    "updatedByexternalSystemId":"completedsnapshotsmonitor" null,
    "externalSystemType": null,
    "updatedOntaskNotes":"2020-03-16 16:03:43 -0500", "",
    "groupId": 1,
    "taskIdroleId":50702 15901,
        "taskStatusenvironment":"PENDING", {
       "externalIdenvironmentId":null 10051,
      "environmentName":  "externalSystemIdDev":null,
       "environmentCode": "externalSystemTypeDEV":null,
    },
    "taskNotesrelease":null,  {
      "groupIdreleaseId":10942 703416,
        "roleIdreleaseName":11601, "Sample Release",
      "environmentreleaseDescription":{ null
    },
      "environmentIdpipelineExecution":11595,
      {
      "environmentNamepipelineId":"Dev",
      702655,
      "environmentCodepipelineExecutionId":"DEV" 898141,
       },
 "executionStatus": "RUNNING",
      "releaseactiveStageExecution": {

           "releaseIdstageExecutionId":50157 898143,
            "releaseNameenvironmentId":"Test Release"10051,
        }"executionStatus": "RUNNING_GATES",
        "pipelineExecutionstartTime":{    null,
        "pipelineIdendTime":54957 null,
 
          "pipelineExecutionIdactiveStep":104553, {
           "executionStatusid":"RUNNING" 706075,
            "activeStageExecutionexecutionId":{ 898144,
               "stageExecutionId":104554,
     "executionStatus": "PENDING_APPROVAL",
          "environmentIdisGate":11595, true
        }
      "executionStatus":"RUNNING_GATES",
}
    },
    "snapshotId": 898134,
    "startTimeworkflow": 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
{
  "endTimeeventType":null "User Created",
  "actor": "fdadmin",
  "object": "marge",
  "timestamp": "2023-10-19 12:57:41 -0500",
  "activeSteppayload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-10-19 12:57:41 -0500",
    "updatedBy":  "idfdadmin":54961,
    "updatedOn": "2023-10-19 12:57:41 -0500",
    "userId": 29191963,
    "email":  "executionId":104555large.marge@gmail.com",
    "firstName": "large",
         "isActive": true,
    "executionStatuslastName": "PENDING_APPROVALmarge",
    "localUser": true,
    "userName": "marge",
    "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.

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

...

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

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

...