Engine Events #

Engine Configuration Events #

Engine Configuration Activation #

[email protected]

Sends a notification when a new engine configuration is activated.

Permissions: engine-configs-read

Payload:

{
	"id": "9bsv0s78ajk0036f3m60",
	"created_at": "2020-09-10T21:01:20Z",
	"updated_at": "2020-09-10T21:01:20Z",
	"used_at": "2020-10-10T20:01:20Z",
	"name": "engine1"
}

Engine configuration properties are described in detail here. Note that the scheme property is omitted from the returned engine configuration object.

Active Engine Configuration Session Update #

[email protected]

Sends a notification when the active engine configuration session is updated.

Permissions: engine-configs-read

Payload:

{
	"config": {
		"id": "9bsv0s78ajk0036f3m60",
		"created_at": "2020-09-10T21:01:20Z",
		"updated_at": "2020-09-10T21:01:20Z",
		"used_at": "2020-10-10T20:01:20Z",
		"name": "engine1"
	},
	"session": {
		"symbols": {
			"ETH_BTC": {
				"enabled_at": "2020-10-10T21:01:20Z",
				"first_cycle": 30
			},
			"BTC_USDT": {
				"enabled_at": "2020-10-10T22:01:20Z",
				"first_cycle": 30
			}
		}
	}
}

• config - object
  The engine configuration data.

  Engine configuration properties are described in detail here. Note that the scheme property is omitted from the returned engine configuration object.

• session - object
  The engine configuration session data.

  Engine configuration session properties are described in detail here.

Engine State Events #

Engine State Update #

[email protected]

Sends a notification when the engine’s state is updated.

Permissions: engine-state-read

Payload:

{
	"action": "stop",
	"changed_at": "2020-09-10T21:01:20Z",
	"uptime": "1h0m0s"
}

• action - string (enum)
  The action that caused the state update. Possible values:

  • start
  • stop

• changed_at - string (RFC 3339)
  The exact time when the state of the engine was changed (e.g., from running to idle).

• uptime - string (duration)
  Specifies the duration that has elapsed since the start of the engine’s process.

Engine Cycle Events #

Engine Cycle Start #

[email protected]

Sends a notification when a new engine cycle is started.

Permissions: engine-cycles-read

Payload:

{
	"session_id": "9bsv0s78ajk0036f3m60",
	"number": 300
	"started_at": "2020-09-10T21:01:20Z"
}

Active engine cycle properties are described in detail here.

Engine Cycle Completion #

[email protected]

Sends a notification when an engine cycle is completed.

Permissions: engine-cycles-read

Payload:

{
	"id": "9bsv0s78ajk0036f3m60",
	"session_id": "38sv0s78ajk0036f3m60",
	"number": 300,
	"started_at": "2020-09-10T21:01:20Z",
	"completed_at": "2020-09-10T21:02:20Z",
}

Engine cycle properties are described in detail here. Note that the report property is omitted from the returned engine cycle object.