Event handlers and triggers

SFTPPlus MFT includes an event handling system that tracks and responds to all actions performed by the application. Every operation in SFTPPlus generates an event, which can then be processed automatically through configured event handlers.

Event Generation ​

Events are created for all key activities within SFTPPlus. This includes:

  • Transfer operations initiated by external file transfer clients connected to the SFTPPlus server.
  • Transfer operations started by SFTPPlus itself during client-side transfers.
  • Administrative actions such as configuration changes or system management operations.

Each event records details about what happened, when it occurred, which components of SFTPPlus generated the event and who performed the action.

To identify who performed an action, the event includes username, source IP address and port number as well as the email address of that user.

This information is standardized and can be used for structured logging. Check the events reference documentation to discover all the available events.

Event Handling Engine ​

SFTPPlus includes an internal event handling engine that allows specific actions to be triggered in response to these events. Administrators can define rules that link events to automated actions, creating flexible workflows without external scripting.

Below are use cases for event handlers

  • Audit Logging: A basic event handler can record all activity in an audit log. This log provides a complete record of transfers, user actions, and system events.

  • Notifications and Alerts: Event handlers can send alerts or notifications when certain events occur. For example, SFTPPlus can send an email or publish a message to an MQTT server when a file is received or a transfer fails.

  • Follow-up Actions: SFTPPlus can trigger external workflows by sending HTTP webhooks. This allows other systems or automation tools to process newly received files or update records based on SFTPPlus events.

You can find the full list of available event handlers as part of the documentation page

Event Groups ​

In SFTPPlus, each event is a member of one or more event groups. These groups categorize events and can be used to filter which actions are triggered by the event handling engine.

Event groups replace traditional log levels such as debug, info, or warning. Instead, SFTPPlus uses functional group labels such as:

  • informational – General system or operational messages.
  • success – Events that indicate a completed operation.
  • failure – Events that signal a failed operation.
  • failure-critical – Events that report serious errors requiring attention.

Beyond describing the event type or severity, event groups also identify the component that generated the event. For example:

  • Events from administrative or configuration operations belong to the admin group.
  • Events generated by the SFTP server belong to the sftp group.
  • Other components, such as user authentication, HTTP file transfer service, or PGP handler, have their own corresponding groups.

This structure allows fine-grained control over event handling. Administrators can configure handlers to act only on events from specific components or with certain severity types, for instance, sending notifications only for failure-critical events from the sftp group.

Check the full list of available groups as part of the event groups documentation page

Summary ​

The event handling system in SFTPPlus MFT provides a unified way to monitor, filter, and respond to activity across all components. With event groups and customizable handlers, administrators can control when and how actions such as logging, notifications, or external integrations occur.

This approach simplifies monitoring, supports automation, and provides consistent visibility across all file transfer and management operations.