IB Drive Folder Trigger
Description
The IB Drive Folder Trigger starts a workflow automatically when a configured folder event occurs in IB Drive.
The trigger can monitor the entire IB Drive or be scoped to a specific folder and can optionally include its nested folders. You can also filter the folders to monitor based on their names.
Supported events include folder creation, deletion, rename, and move operations.
Design-Time Configuration
Scope
Defines the location within IB Drive that the trigger monitors for folder events.
Root Folder Item Id
Specifies the unique IB Drive item ID of the folder to monitor.
If specified, the trigger monitors folder events within this folder.
If left empty, the trigger monitors folder events across the entire IB Drive.
This property is optional.
Include Subfolders
Determines whether nested folders within the configured Root Folder Item Id are also monitored.
| Value | Description |
|---|---|
| Enabled | Monitors folder events within the specified folder and all its nested folders. |
| Disabled | Monitors only folder events for folders directly contained within the specified folder. |
This option applies when Root Folder Item Id is specified.
Filters
Folder Filter
Specifies an optional wildcard pattern used to determine which folder names can trigger the workflow.
For example:
Archive*— matches folder names that start withArchive.*-Processed— matches folder names that end with-Processed.Invoice-*— matches folder names that start withInvoice-.
If no filter is specified, folder events are monitored regardless of the folder name.
Events
Select one or more folder events that should trigger the workflow.
| Event | Description |
|---|---|
| On Created | Triggers when a new folder is created in IB Drive. |
| On Deleted | Triggers when a folder is deleted and moved to the Recycle Bin. |
| On Renamed | Triggers when an existing folder is renamed. |
| On Moved | Triggers when an existing folder is moved to a different parent 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 folder event that triggered the workflow, such as Created, Deleted, Renamed, or Moved. |
| Item | Contains information about the folder associated with the event, including properties such as ItemId, Name, Location, ParentId, 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 folder 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 folder. |
| Deleted | (None) | No additional event-specific properties are returned. The Item property contains information about the folder associated with the deletion event. |
| Renamed | OldName | Contains the previous name of the folder before it was renamed. |
| Moved | OldLocationNewLocationOldParentId | Contains information about the folder's previous and new location. |
For a Moved event:
| Property | Description |
|---|---|
| OldLocation | The logical IB Drive path of the folder before it was moved. |
| NewLocation | The logical IB Drive path of the folder after it was moved. |
| OldParentId | The unique item ID of the parent folder that contained the folder before it was moved. |
Remarks
- The trigger starts a new workflow execution when a matching IB Drive folder 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 Folder Filter to restrict triggering to folders 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 folder event caused the workflow to start. - For rename and move events, use
EventDatato access information about the folder's previous name or location.