Long-Running Actions

Overview

When you create actions in Forge, they typically stop running when a user navigates away from the page. However, for operations like batch migrations or data processing that need to run for extended periods, you can make your actions continue in the background.

Making Actions Run in Background

To keep an action running even after the user leaves the page, set backgroundable: true in your action definition:

import { Action } from "@forge/sdk";

export default new Action({
  backgroundable: true,
  handler: async () => {
    // Your long-running code here
  },
});

User Notifications

Forge will notify the user who initiated the action for the following events

• Success
• Awaiting input
• Error

Best Practices

Use background actions for time-intensive operations like:

• Data migrations
• Batch processing
• System-wide updates

Consider adding user prompts for error handling instead of failing silently