Skip to content
Sirveo Documentation

System events

This reference covers all system events that is generated by the server. These events have a kind value of "sys".

General server events

server.ready

Raised when the server starts.

server.shutdown

Raised when the server starts it’s graceful shutdown process. Typically triggered by SIGINT. Data fields include reason.

license.invalid

Raised when the server’s configured license status changes from valid to invalid. Fields include msg, which describes the reason.

license.valid

Raised when the server’s configured license status changes from invalid to valid. Fields include msg, which describes the reason.

Authentication

auth.ok

Raised when successful authentication occurs via the API. Includes data fields username, ip and exp. The latter is the expiry timestamp of the JWT that the server isssued the client with.

auth.error

Raised when authentication fails via the API. Includes data fields username, ip, reason.

auth.renew

Raised when successful authentication token renewal occurs via the API. Includes data fields username, ip and exp. The latter is the expiry timestamp of the JWT that the server isssued the client with.

Schedule triggers

trigger.schedule.sync*

Raised when the server completed it’s scheduler synchronization between the database, it’s internal schedule cache, and jobs in its scheduler.

trigger.schedule.ok

Raised when the server’s scheduler executes the target flow of a schedule trigger, without an error. Data fields include:

  • schedule_id
  • schedule_name
  • flow_id
  • flow_name
  • inputs (number of flow input data items)
  • outputs (number of flow output data items)
  • duration_ms
  • ok (boolean, true if the flow executed without errors)
  • error (populated if ok is not true)
  • status as set by a status node, or unknown
  • status_msg as set by a status node, or empty

trigger.schedule.error

Raised when the server’s scheduler executes the target flow of a schedule trigger, but with an error. Data fields are the same as the trigger.schedule.ok event.

trigger.schedule.failed

Raised when a schedule trigger attempts to run a flow, and encounters an error that prevents it from executing the target flow. Fields include trigger_id, flow_id and error. The error may contain:

  • failed to fetch target flow: ... - Likely a database connection issue, and the flow definition was not present in the server’s cache. Won’t disable schedule trigger.

  • flow validation failed: ... - The flow engine rejected the flow definition. This may happen after a version upgrade introduces breaking changes to flow definitions. To fix, open the target flow and save it. There will be descriptive errors. The server will attempt to disable the schedule trigger.

  • failed to prepare input data: ... - The server could not parse or process flow input data as valid JSON. The server will attempt to disable the schedule trigger.

  • flow rejected input data: ... - Similar to the above issue. The server will attempt to disable the schedule trigger.

trigger.schedule.disabled

Raised when the schedule trigger processing system successfully disables a schedule trigger, due to certain critical error. This event is always raised after an associated trigger.schedule.failed event. Fields include trigger_id, flow_id, reason. Reason may contain:

  • flow validation failed: ...
  • failed to prepare input data: ...
  • flow rejected input data: ...

Event triggers

trigger.event.sync*

Raised when the server completed it’s scheduler synchronization between the database, it’s internal schedule cache, and jobs in its scheduler.

trigger.event.ok

Raised when an event trigger executes its target flow successfully. Data fields include:

  • trigger_id
  • trigger_name
  • trigger_priority
  • flow_id
  • flow_name
  • inputs (number of flow input data items)
  • outputs (number of flow output data items)
  • duration_ms
  • ok (boolean, true if the flow executed without errors)
  • error (populated if ok is not true)
  • event_id (of the triggering event)
  • event_type
  • status as set by a status node, or unknown
  • status_msg as set by a status node, or empty

trigger.event.error

Raised when an event trigger executes its target flow, but with an error. Data fields are the same as the trigger.event.ok event.

trigger.event.failed

Raised when an event trigger attempts to run a flow, and encounters an error that prevents it from executing the target flow. Fields include trigger_id, flow_id, event_id and error. The error may contain:

  • failed to fetch target flow: ... - Likely a database connection issue, and the flow definition was not present in the server’s cache. Won’t disable event trigger.

  • flow validation failed: ... - The flow engine rejected the flow definition. This may happen after a version upgrade introduces breaking changes to flow definitions. To fix, open the target flow and save it. There will be descriptive errors. The server will attempt to disable the event trigger.

  • failed to prepare input data: ... - The server could not parse or process flow input data as valid JSON. Won’t disable event trigger.

  • flow rejected input data: ... - Similar to the above issue. Won’t disable event trigger.

trigger.event.disabled

Raised when the event processing system successfully disables an event trigger, due to a critical error. This event is always raised after an associated trigger.event.error event. Fields include trigger_id, flow_id, reason. Reason may contain:

  • flow validation failed: ... (See above)