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

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": "Pipeline Version Activated",
  "actor": "fdadmin",
  "object": "56502",
  "timestamp": "2024-03-12 10:18:50 -0500",
  "payload": {
    "createdBy": "fdadmin",
    "createdOn": "2023-04-18 12:36:55 -0500",
    "updatedBy": "fdadmin",
    "updatedOn": "2023-10-09 13:11:03 -0500",
    "pipeline": {
      "pipelineId": 56501,
      "pipelineName": "Sample Pipeline"
    },
    "description": null,
    "pipelineVersionId": 56502,
    "pipelineVersion": "1"
  }
}

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.

...

languagejson

...

Project Created/Activated/Inactivated/Deleted

@Since 8.0.0.2The Project Events are sent when a project is Created, Activated, Inactivated, and deleted.

Code Block
{
  "eventType": "Project Created",
  "actor": "karl.henselin@flexagon.com",
  "object": "10175",
  "timestamp": "2024-05-09 07:55:18 -0500",
     "payload": {
    "description": "HR MDS Objects",
    "releaseactive":{ true,
            "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
languagejson
{
    "eventType":"Release Ended",
    "actor":"fdadmin",
    "object":"testRelease",
    "timestamp":"2020-10-18 16:10:55 -0500",
    "payload":  "folder": {
      "folderId": 10714,
      "folderPath": "FlexDeploy / HumanResources / HRApp"
    },
    "projectName": "HRMDSObjects",
    "projectId": 10175,
    "projectType": null,
    "scmType": "GIT"
  }
}
Code Block
{
  "eventType": "Project Activated",
  "actor": "karl.henselin@flexagon.com",
  "object": "81593556",
  "timestamp": "2024-05-09 07:54:06 -0500",
  "payload": {
    "description": null,
    "active": true,
    "folder": {
      "folderId": 727448,
      "folderPath": "FlexDeploy / Karl"
    },
    "projectName": "10587",
    "projectId": 81593556,
    "projectType": "UTILITY",
    "scmType": "NONE"
  }
}
Code Block
{
  "eventType": "Project Inactivated",
  "actor": "karl.henselin@flexagon.com",
  "object": "1000909",
  "timestamp": "2024-05-09 07:56:02 -0500",
  "payload": {
    "description": "Project created with API",
    "active": true,
    "folder": {
      "folderId": 759142,
      "folderPath": "FlexDeploy / SoapUI Testing"
    },
    "projectName": "XXHRPostman",
    "projectId": 1000909,
    "projectType": "EBS",
    "scmType": "GIT"
  }
}
Code Block

  "eventType": "Project Deleted",
  "actor": "karl.henselin@flexagon.com",
  "object": "65249022",
  "timestamp": "2024-05-09 07:57:34 -0500",
  "payload": {
    "description": null,
    "active": true,
    "folder": {
      "folderId": 727448,
      "folderPath": "FlexDeploy / Karl"
    },
    "projectName": "JDBC",
    "projectId": 65249022,
    "projectType": "PARTIAL_JDBC",
    "scmType": "GIT"
  }
}

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": {
          "releaseenvironmentId":{ 11595,
          "environmentName": "releaseIdDev123":54052,
 
          "releaseNameenvironmentCode": "testRelease",DEV1"
        },
        "releaseDescriptiongroupName": null
      },
 },     {
        "startDateprojectId":"2020-09-18" 19422906,
        "endDateprojectName":null "Build 503",
        "projectspackageName":[ null,
        "streamName": "master",
   {     "buildEnvironment": {
          "projectIdenvironmentId":440135,
      223477,
          "projectNameenvironmentName": "partialFile503 Build",
 
              "streamNameenvironmentCode": "master503BUILD",
        },
        "buildEnvironmentgroupName":{ null
      },
      {
        "environmentIdprojectId":null 19667075,
        "projectName": "XXHR TFVC",
        "packageName": "environmentNamePkg1":null,
           "streamName": "master",
        "environmentCodebuildEnvironment":null {
          "environmentId": 418564,
     },     "environmentName": "Development",
          "groupNameenvironmentCode":null "DEV"
        },
  }      "groupName": null
  ],    }
    "pipeline":{],
    "pipeline": {
      "pipelineId":17854 198497,

           "pipelineName": "DanPipeline"
   Pipeline Check"
    }
 
  }
}

Snapshot Completed

The Snapshot Completed event is triggered whenever a snapshot builds successfully and is entering the first stage, or fails to build.

...