Running Platform Event Triggered Flows As Custom User IDs

Jul 17, 2025 by ADMIN 58 views

Running Platform Event Triggered Flows with Custom User IDs

Introduction

Hey guys! Ever found yourself in a situation where you need a flow triggered by a platform event to run under the context of a specific user? Maybe you have a UserId__c field in your platform event and want the flow to behave as if that user initiated it. It's a common scenario, and thankfully, there are ways to achieve this in Salesforce. Let's dive into how you can make this happen.

Understanding the Challenge

The challenge lies in the fact that flows, by default, run in the context of the Automated Process user when triggered by platform events. This is a system user with limited permissions, which might not be suitable for all operations. You might need the flow to access specific records or perform actions that require a user with a particular profile or permission sets. Running a flow as a custom user allows you to overcome these limitations, ensuring your flow has the necessary permissions and context to execute correctly. This is especially crucial when dealing with security-sensitive operations or when you need to maintain proper audit trails.

Furthermore, you might want to leverage the user's specific settings, such as their time zone or locale, within the flow. Imagine a scenario where you're sending email notifications; you'd want the timestamps to reflect the recipient's time zone, not the system's. By executing the flow as the intended user, you ensure a more personalized and accurate experience. Think of it as stepping into the shoes of that user, allowing the flow to act on their behalf.

To illustrate, consider a platform event triggered when a new lead is created. You want to automatically assign the lead to a sales representative based on certain criteria. If the flow runs as the Automated Process user, it might not have the necessary permissions to access the assignment rules or the sales representative's profile. By setting the user context to a specific user, such as the sales manager, you ensure the flow can access the required data and make the assignment correctly. This not only streamlines the process but also maintains data integrity and security.

Why Run Flows as a Specific User?

So, why bother with all this? Well, here's the deal: running a flow as a specific user gives you a ton of control and flexibility. Imagine you've got a platform event that fires when a record is updated. You want the flow to perform some actions on behalf of the user who made the update. If the flow runs in the system context, it might not have the right permissions, and you could run into issues. By using a custom user ID, you ensure the flow operates with the correct permissions and context, making everything smoother and more secure.

Think about scenarios where you need to enforce specific sharing rules or field-level security. The Automated Process user might bypass these rules, leading to unintended data access or modification. Running the flow as the actual user ensures that these rules are respected, maintaining the integrity of your data. It's like having a virtual assistant who acts exactly as the user would, adhering to all their permissions and restrictions. This becomes even more critical in regulated industries where compliance is paramount.

Another compelling reason is auditability. When flows run in the system context, it can be challenging to track who initiated the action. By running the flow as a specific user, you create a clear audit trail, making it easier to identify who performed what action and when. This is invaluable for troubleshooting, security analysis, and compliance reporting. It's like having a detailed logbook that records every step taken by the user, ensuring transparency and accountability.

Options for Implementing Custom User Context

Now, let’s explore how we can actually implement this. There are primarily two approaches you can take:

Apex Invocable Method: This involves creating an Apex method that accepts the UserId__c from the platform event and uses System.runAs() to execute the flow logic in the context of that user.
Platform Event Field Mapping (Pilot): Salesforce offers a pilot feature that allows you to map a field from the platform event directly to the User ID within the flow. This simplifies the process and reduces the need for Apex code.

Option 1: Apex Invocable Method

The Apex Invocable Method approach is a classic and reliable way to handle custom user contexts in flows. It gives you fine-grained control over the execution context and allows you to perform additional logic before or after the flow runs. Let's break down how this works step-by-step.

Step 1: Create an Apex Class with an Invocable Method

First, you'll need to create an Apex class with a method annotated with @InvocableMethod. This annotation tells Salesforce that this method can be called from a flow. The method should accept the UserId__c from the platform event as input and then use System.runAs() to execute the flow logic in the context of that user. The @InvocableMethod annotation is the key here, as it exposes your Apex code to the flow engine, allowing you to seamlessly integrate custom logic into your flows.

Here’s a basic example of how the Apex class might look:

public class FlowRunner {
    @InvocableMethod(label='Run Flow as User' description='Runs a flow in the context of a specified user.')
    public static void runFlowAsUser(List<Request> requests) {
        String userId = requests.get(0).userId;
        String flowName = requests.get(0).flowName;
        Map<String, Object> inputVariables = requests.get(0).inputVariables;

        System.runAs(new User(Id = userId)) {
            Flow.Interview.YourFlowName flowInterview = new Flow.Interview.YourFlowName(inputVariables);
            flowInterview.start();
        }
    }

    public class Request {
        @InvocableVariable(label='User ID' description='The ID of the user to run the flow as' required=true)
        public String userId;
        @InvocableVariable(label='Flow Name' description='The name of the flow to run' required=true)
        public String flowName;
        @InvocableVariable(label='Input Variables' description='Input variables for the flow')
        public Map<String, Object> inputVariables;
    }
}

In this example, the runFlowAsUser method takes a list of Request objects. Each Request object contains the UserId, the name of the flow to run (flowName), and any input variables (inputVariables) that the flow might need. The System.runAs() method is the magic sauce here. It allows you to execute code as a different user, effectively changing the security context of the operation.

Step 2: Modify Your Platform Event Triggered Flow

Next, you'll need to modify your platform event triggered flow to call this Apex method. Remove any direct logic from the flow and replace it with an Apex Action element that calls your runFlowAsUser method. You'll need to pass the UserId__c from the platform event to the Apex method, along with the name of the flow you want to run and any other necessary input variables.

When configuring the Apex Action element, make sure to map the UserId__c field from the platform event to the userId input variable of the Apex method. You'll also need to specify the name of the flow to run in the flowName input variable. If your flow requires any input variables, you can map them from the platform event or set them directly in the Apex Action element. Properly mapping the input variables is crucial for the flow to run correctly in the new user context.

Step 3: Test Your Flow

Finally, thoroughly test your flow to ensure it runs as expected in the context of the specified user. Publish a platform event with a valid UserId__c and verify that the flow executes correctly. Check the debug logs to confirm that the code is running under the intended user's context. Comprehensive testing is essential to catch any potential issues and ensure the flow behaves as expected in a production environment.

By using Apex Invocable Methods, you gain a powerful tool for managing user context in flows, enabling you to build more flexible and secure automation solutions.

Option 2: Platform Event Field Mapping (Pilot)

Salesforce's Platform Event Field Mapping Pilot is a game-changer for simplifying the process of running flows as specific users. This feature, still in pilot as of this writing, allows you to directly map a field from your platform event to the User ID in the flow's context. This eliminates the need for Apex code in many cases, making your flows cleaner and easier to maintain. The Platform Event Field Mapping Pilot is a testament to Salesforce's commitment to streamlining automation and empowering developers and admins alike.

How It Works

The basic idea is that you can tell the flow,