Events

Common Event Fields

Each incoming event passes an event payload to the listener depending on the event type. Below are example payloads for each event type.

All Event messages have the following top level fields:

Key

Description

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

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.

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

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

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

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.

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

Workflow Completed (TEST) Event Payload

Work Item Created

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

Work Item Updated

The Work Item Updated event is triggered whenever work item is updated.

 

The following macros are not currently supported in the footer:
  • style