Skip to main content

Events Reference

This is the reference documentation of the built-in events which comes out-of-the-box with PIPEFORCE.

Here is an example on how to listen for such events in a persisted pipeline:

pipeline:
 - event.listen:
     key: "iam.login.error"
 - log:
     message: "A login has been failed!"

Every time an event is fired matching the given criteria, all commands after event.listen will be executed.

Also see the Event Guide for details about the structure and usage of events.

property.created​

It is fired every time a new property gets created in the property store.

It contains as origin, the value null, and as target, the property created before. 

{
  "payload": {
    "origin": null,
    "target": {
      "uuid": "string",
      "key": "string",
      "type": "string",
      "value": "string",
      "created": timestamp,
      "updated": timestamp
    }
  }
}

property.copied​

It is fired every time a property gets copied in the property store.

It contains as origin, the source property, and as target, the property where source was copied to.

{
  "payload": {
    "origin": {
      "uuid": "string",
      "key": "string",
      "type": "string",
      "value": "string",
      "created": timestamp,
      "updated": timestamp
    },
    "target": {
      "uuid": "string",
      "key": "string",
      "type": "string",
      "value": "string",
      "created": timestamp,
      "updated": timestamp
    }
  }
}

property.deleted​

It is fired every time a property was deleted from the property store.

It contains as origin, the property which was deleted, and as target, the value null.

{
  "payload": {
    "origin": {
      "uuid": "string",
      "key": "string",
      "type": "string",
      "value": "string",
      "created": timestamp,
      "updated": timestamp
    },
    "target": null
  }
}

property.moved​

It is fired every time a property was moved from one key to another.

It contains as origin, the key of the source property, and as target, the key of the property where it was moved to.

{
  "payload": {
    "origin": "string",
    "target": "string"
  }
}

property.updated​

It is fired after a property has been updated in the property store.

It contains as origin, the property before the update, and as target, the property after the update.

{
  "payload": {
    "origin": {
      "uuid": "string",
      "key": "string",
      "type": "string",
      "value": "string",
      "created": timestamp,
      "updated": timestamp
    },
    "target": {
      "uuid": "string",
      "key": "string",
      "type": "string",
      "value": "string",
      "created": timestamp,
      "updated": timestamp
    }
  }
}

setup.finished​

It is fired after the hub service gets successfully started, and all setup scripts have been executed successfully.

This event contains no payload.

setup.starting​

It is fired after the hub service was successfully started, but right before all setup scripts are executed.

This event contains no payload.

hub.context.started​

It is fired after the hub service was successfully started.

It contains as origin, the configuration of the context as key-value-pairs. The target is null.

{
  "payload": {
    "origin": {
      "key1": "value1",
      "key2": "value2"
    },
    "target": null
  }
}

iam.bruteforce.detected​

It is fired every time a potential brute force attempt was detected.

iam.login.error​

It is fired every time a login attempt gets failed.

Report an Issue​

Your help is needed!

In case you're missing something on this page, you found an error or you have an idea for improvement, please click here to create a new issue. Another way to contribute is, to click Edit this page below and directly add your changes in GitHub. Many thanks for your contribution in order to improve PIPEFORCE!