IB Drive File Trigger
Description
The IB Drive File Trigger starts a workflow automatically when a configured file event occurs in IB Drive.
The trigger can monitor the entire IB Drive or be scoped to a specific folder and can optionally include files within its subfolders. You can also filter the files to monitor based on their names.
Supported events include file creation, modification, deletion, rename, and move operations.
Design-Time Configuration
Scope
Defines the location within IB Drive that the trigger monitors for file events.
Root Folder Item Id
Specifies the unique IB Drive item ID of the folder to monitor.
If specified, the trigger monitors file events within this folder.
If left empty, the trigger monitors file events across the entire IB Drive.
This property is optional.
Include Subfolders
Determines whether files within subfolders of the configured Root Folder Item Id are also monitored.
| Value | Description |
|---|---|
| Enabled | Monitors files within the specified folder and all its nested subfolders. |
| Disabled | Monitors only files directly contained within the specified folder. |
This option applies when Root Folder Item Id is specified.
Filters
File Filter
Specifies an optional wildcard pattern used to determine which file names can trigger the workflow.
For example:
*.pdf— matches all PDF files.invoice-*.xlsx— matches Excel files whose names start withinvoice-.report-2026-*.pdf— matches PDF files whose names start withreport-2026-.
If no filter is specified, file events are monitored regardless of the file name.
Events
Select one or more file events that should trigger the workflow.
| Event | Description |
|---|---|
| On Created | Triggers when a new file is created or uploaded to IB Drive. |
| On Changed | Triggers when the contents of an existing file are modified. |
| On Deleted | Triggers when a file is deleted and moved to the Recycle Bin. |
| On Renamed | Triggers when an existing file is renamed. |
| On Moved | Triggers when an existing file is moved to a different folder. |
Only the events that are enabled in the trigger configuration start the workflow.
Outputs
Event Payload
The trigger provides a unified Event Payload containing information about the event that started the workflow.
| Property | Description |
|---|---|
| TriggeredAt | The UTC date and time when the workflow was triggered. |
| RunId | The unique identifier associated with the trigger run. |
| EventType | The type of file event that triggered the workflow, such as Created, Changed, Deleted, Renamed, or Moved. |
| Item | Contains information about the file associated with the event, including properties such as ItemId, Name, Location, Size, ContentType, Created, and Modified. |
| EventData | Contains additional event-specific information. The properties available depend on the EventType. |
EventData Details
The contents of EventData depend on the type of file event that triggered the workflow.
| EventType | Returned Properties | Description |
|---|---|---|
| Created | (None) | No additional event-specific properties are returned. Use Item for information about the created file. |
| Changed | (None) | No additional event-specific properties are returned. Use Item for the current state of the file. |
| Deleted | (None) | No additional event-specific properties are returned. The Item property contains information about the file associated with the deletion event. |
| Renamed | OldName | Contains the previous name of the file before it was renamed. |
| Moved | OldLocationNewLocationOldParentId | Contains information about the file's previous and new location. |
For a Moved event:
| Property | Description |
|---|---|
| OldLocation | The logical IB Drive path of the file before it was moved. |
| NewLocation | The logical IB Drive path of the file after it was moved. |
| OldParentId | The unique item ID of the folder that contained the file before it was moved. |
Remarks
- The trigger starts a new workflow execution when a matching IB Drive file event occurs.
- At least one event must be enabled for the trigger to start workflows.
- If Root Folder Item Id is not specified, the trigger monitors the entire IB Drive.
- Use Include Subfolders to control whether nested folders are included when monitoring a specific folder.
- Use File Filter to restrict triggering to files whose names match a specific wildcard pattern.
- Multiple event types can be enabled within the same trigger.
- The
EventTypeproperty can be used within the workflow to determine which file event caused the workflow to start. - For rename and move events, use
EventDatato access information about the file's previous name or location.