Getting Started

This guide will walk you through installing and setting up apex-async-actions in your Salesforce org.

Step 1: Install the Package

apex-async-actions is distributed as an unlocked package. Find the latest version in the GitHub Releases page.

Install using the Salesforce CLI:

sf package install --package 04tXXXXXXXXXXXXXX --wait 10

Replace 04tXXXXXXXXXXXXXX with the actual package version ID from the releases page.

Alternatively, you can install via the Salesforce UI by visiting:

https://login.salesforce.com/packaging/installPackage.apexp?p0=04tXXXXXXXXXXXXXX

Step 2: Assign Permissions

The framework includes the AsyncActionAdministrator permission set for admin users who need to monitor, retry, and manually intervene with async actions. This permission set is not required for end users to trigger or execute async actions.

Assign it to users who need administrative access:

sf org assign permset -n AsyncActionAdministrator

Or assign via Setup → Users → Permission Sets in the Salesforce UI.

Step 3: Build Async Action Processors

Once you've completed the installation, create your first async action using these step-by-step instructions: Creating Your First Processor.