Event Type

systemEvent

Entity Action

HEALTHCHECK

Firing Condition

At consistent time intervals to assess the reachability and functionality of a downstream listener, and also during the configuration process to validate credentials before activating a subscription.

Valid Decorators

Decorators are not used for outbound events of type systemEvent.

Object Format

{
  "id": UUID
  "firstEmittedAt": ISO8601 DateTime String
  "lastEmittedAt": ISO8601 DateTime String
  "attempt": Integer
  "status": String
  "data": {
    "type": "system"
    "action": "healthcheck"
  }
}

Expected Response

The event system will accept any response with a status code of 200 as a successful check. If you wish to include more information (such as downstream component systems or versioning data that may assist in troubleshooting) you may include them in the optional response body with type application/json in the following format:

{
    "metadata": {
      "yourCustomKey1": {},
      "yourCustomKeyn": 'someValue'
  }
}

Similarly, any non-20x code will register as a failure. You may also return an optional response body with additional information that may assist in troubleshooting if you wish in the following format:

{
    "error": {
      "yourCustomKey1": {},
      "yourCustomKeyn": 'someValue'
  }
}