To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Fired when an integration pipeline starts running, completes or fails, so apps can react to the outcome of a data import or export. It has event id "pipelineProcess". Which of the three happened is given by trigger item 3, from the PipelineEventAction of STARTED, COMPLETED or FAILED. The event is queued through the asynchronous processor when the pipeline runs, so it is dispatched on a background thread in its own session, after the pipeline's own transaction, rather than inline with the pipeline run. It is a trigger event, keyed on website id (trigger item 1), pipeline endpoint id (trigger item 2) and the action (trigger item 3). The pipeline itself is available both from getPipeline and from the "pipeline" entry of the attributes map.
Implements: TriggerEvent
Properties
| Property | Returns | Description |
|---|---|---|
| attributes | Map<String,Object> | The mutable attribute map for this event. Always contains "pipeline", the PipelineBean for the run; listeners may add their own entries to pass values on to later handlers and to email templates. |
| eventId | String | The persistent identifier for this event type, always "pipelineProcess". Used by the trigger system to select handlers. |
| pipeline | PipelineBean | A detached snapshot of the pipeline configuration that was run, including its endpoint id and organisation. Also available in the attributes map under "pipeline". |
| sourceProfile | Profile | The profile the pipeline run was attributed to, ie the current user when the pipeline was triggered. |
| triggerItem1 | String | The id of the website the pipeline is configured on, as a string, for trigger matching. |
| triggerItem2 | String | The endpoint id of the pipeline, for trigger matching, so a trigger can be bound to one specific pipeline. |
| triggerItem3 | String | The name of the pipeline action, one of "STARTED", "COMPLETED" or "FAILED", for trigger matching. |
| triggerItem4 | String | Not used by this event, always null. |
| triggerItem5 | String | Not used by this event, always null. |
| website | Website | The website the pipeline is configured on. |
Inherited from TriggerEvent
Properties
| Property | Returns | Description |
|---|---|---|
| serialisable | boolean | Whether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here. |
Methods
isSerialisable()
Returns: boolean
Whether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.
Methods
getEventId() · getWebsite() · getSourceProfile() · getTriggerItem1() · getTriggerItem2() · getTriggerItem3() · getTriggerItem4() · getTriggerItem5() · getAttributes() · getPipeline()
getEventId()
Returns: String
The persistent identifier for this event type, always "pipelineProcess". Used by the trigger system to select handlers.
getWebsite()
Returns: Website
The website the pipeline is configured on.
getSourceProfile()
Returns: Profile
The profile the pipeline run was attributed to, ie the current user when the pipeline was triggered.
getTriggerItem1()
Returns: String
The id of the website the pipeline is configured on, as a string, for trigger matching.
getTriggerItem2()
Returns: String
The endpoint id of the pipeline, for trigger matching, so a trigger can be bound to one specific pipeline.
getTriggerItem3()
Returns: String
The name of the pipeline action, one of "STARTED", "COMPLETED" or "FAILED", for trigger matching.
getTriggerItem4()
Returns: String
Not used by this event, always null.
getTriggerItem5()
Returns: String
Not used by this event, always null.
getAttributes()
Returns: Map<String,Object>
The mutable attribute map for this event. Always contains "pipeline", the PipelineBean for the run; listeners may add their own entries to pass values on to later handlers and to email templates.
getPipeline()
Returns: PipelineBean
A detached snapshot of the pipeline configuration that was run, including its endpoint id and organisation. Also available in the attributes map under "pipeline".
© 2025 Kademi Ltd