Versions Compared

Key

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

...

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

...

Package Status Updated

@Since 7.0.0.1 - The Package Status Updated 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 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":{
            "pipelineExecutionIdreleaseId":null11611,
            "pipelineStageExecutionreleaseName":{"REST Release 1"
        },
        "stageExecutionIdsnapshot":104516,{
            "environmentIdsnapshotId":11595104506,
            "executionStatussnapshotName":"FAILED07-16-2020 15:12:18",
            "startTimesnapshotStatus":"2020-12-16 15:12:19 -0500INITIATED",
            "endTimedescription":"2020-12-16 15:12:41 -0500"null,
            "activeStepreleaseId":null11611
        },
    }
}

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
{
  "pipelineeventType":{ "Release Started",
  "actor": "avnish",
  "object": "Release Build 503",
  "pipelineIdtimestamp":10001,
   "2024-03-25 13:17:08 -0500",
  "payload": {
     "pipelineNamerelease":"Simple" {
      "releaseId": }236634,
 
      "environmentreleaseName":{ "Release Build  503",
        "environmentIdreleaseDescription":11595, "Blackout W test"
    },
    "environmentNamestartDate":"Dev" 1711390628000,
       "endDate": null,
    "environmentCodeprojects":"DEV" [
      {
},         "releaseprojectId":{ 10212437,
          "projectName": "releaseIdXXHR":11611,
   
        "releaseNamepackageName": "RESTJavaPkg",
Release 1"         }"streamName": "master",
        "snapshotbuildEnvironment": {
            "snapshotIdenvironmentId":104506 11595,
 
          "snapshotName":"07-16-2020 15:12:18",
 "environmentName": "Dev123",
          "snapshotStatusenvironmentCode": "INITIATED",DEV1"
        },
        "descriptiongroupName": null,
      },
     "releaseId":11611 {
       } "projectId": 19422906,
  } }

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
{     "eventTypeprojectName": "ReleaseBuild Started503",
        "actorpackageName":"fdadmin", null,
        "objectstreamName": "testReleasemaster",
    "timestamp":"2020-08-18 16:08:48 -0500",     "payloadbuildEnvironment": {
          "releaseenvironmentId":{ 223477,
           "releaseIdenvironmentName":54052, "503 Build",
          "releaseNameenvironmentCode": "testRelease",503BUILD"
        },
        "releaseDescriptiongroupName": null
      },
   },   {
        "startDateprojectId":"2020-09-18" 19667075,
        "endDateprojectName":null "XXHR TFVC",
        "projectspackageName":[ "Pkg1",
        "streamName": "master",
    {    "buildEnvironment":  {
          "projectIdenvironmentId":440135,
      418564,
          "projectNameenvironmentName": "partialFileDevelopment",
    
           "streamNameenvironmentCode": "masterDEV",
        },
        "buildEnvironmentgroupName":{ null
      }
      ],
     "environmentIdpipeline":null, {
      "pipelineId": 198497,
      "pipelineName": "Pipeline Check"
  "environmentName":null,  }
                  "environmentCode":null
                },
         }
}

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": {
      "groupNamereleaseId":null 236634,
      "releaseName": "Release    }
        ],
Build 503",
       "pipelinereleaseDescription":{ "Blackout W test"
    },
    "pipelineIdstartDate":17854 1711390628000,
       "endDate": null,
    "pipelineNameprojects":"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
{
    "eventTypeprojectId":"Release Ended"10212437,
        "actorprojectName": "fdadminXXHR",
        "objectpackageName": "testReleaseJavaPkg",
        "timestampstreamName":"2020-10-18 16:10:55 -0500", "master",
        "payloadbuildEnvironment": {
          "releaseenvironmentId":{ 11595,
          "environmentName": "releaseIdDev123":54052,
            "releaseNameenvironmentCode": "testRelease",DEV1"
        },
        "releaseDescriptiongroupName": null
      },
      {
   }     "projectId": 19422906,
        "startDateprojectName":"2020-09-18 "Build 503",
        "endDatepackageName": null,
        "projectsstreamName":[ "master",
        "buildEnvironment": {
 {         "environmentId": 223477,
      "projectId":440135,    "environmentName": "503 Build",
          "projectNameenvironmentCode": "partialFile503BUILD",
        },
        "streamNamegroupName":"master", null
        },
      "buildEnvironment":{
        "projectId": 19667075,
          "environmentIdprojectName":null, "XXHR TFVC",
        "packageName": "Pkg1",
        "environmentNamestreamName":null "master",
        "buildEnvironment": {
          "environmentCodeenvironmentId":null 418564,
          "environmentName": "Development",
   },       "environmentCode": "DEV"
        "groupName":null},
        "groupName": null
  }    }
    ],
   
    "pipeline": {
  
         "pipelineId":17854,
      198497,
      "pipelineName": "DanPipelinePipeline Check"
 
      }
 
  }
}

Snapshot Completed

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

...