SFTP Blueprint Events

The /blueprints/{blueprint-id}/events folder allows you to interact with existing business processes through blueprint events using SFTP bulk operations.

For more details on how to use batch operations see the Jobs documentation for more details on how to use bulk/batch processing.

Enable

To enable batch processing for a Blueprint you must add a Trigger where the protocol is system and the resource is jobs.line. This will cause the folder to be created in the FTP server, for files to be dropped.

Folder

/blueprints/{blueprint-id}/events

Scopes

jobs:create business_processes:read, business_processes:update

Overview

Blueprint events enable you to trigger actions on business processes that were created through blueprints. This is useful for:

• Approving or rejecting pending processes
• Canceling active processes
• Sending reminders
• Updating process status

File Format

Upload CSV files to the /blueprints/{blueprint-id}/events folder. The CSV should contain the business process ID and the event data.

Column order does not matter.

Required Fields

Event Types

• reminder A reminder message will be sent to the customer attached to the Business Process.
• resolve Will cause the attached to the Business Process to have its status updated to resolved.
• fail Will cause the attached to the Business Process to have its status updated to failed.

Optional Fields

⚠️

Note: Timing will not be exact, delays of up to 20 minutes can occur depending on platform conditions.

Example CSV

This file is providing a resolve or failed status for an action with a known ID, and another row for a seed-id that would have been provided during Business Process creation time.

id,type
00000000-0000-0000-0000-000000000000,resolve
a-seed-value,failed

This is an example of a reminder file using id-seeds.

id,type,schedule
a-seed-value,reminder,1640995200000

Processing

For each valid record:

1. ID validation: Verify business process exists or idSeed is valid
2. Event type validation: Validate event type is supported
3. Schedule validation: Validate timestamp if provided
4. Event creation: Create event for business process
5. Status update: Mark record as processed

Error Codes