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 |
---|---|
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) |
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.
|
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.
|
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 enda sprint in Jira whenever the release is ended.
|
The Snapshot Completed event is triggered whenever a snapshot eventually completes successfully or fails to build.
|
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.
|
The Workflow Completed event is triggered whenever a workflow execution succeeds or fails. Note that this event will trigger for ALL workflow types.
|
|