Skip to main content

Install, upgrade, and migrate Payloads

Install Payloads, complete the post-install checks, upgrade safely, and move Payloads configuration between Salesforce orgs.

Install, upgrade, and migrate Payloads

Install Payloads, assign access and verify its services before running integrations. For v1.53, also verify that existing Payloads migrated to the Actions execution model.

Install and assign access

Use the package installation link supplied by Payloads. Open the Payloads app from the App Launcher and assign Payloads Admin to the users who build and support integrations.

Check the business-object access needed by Queries, Targets and Flows as well as the package permissions. For public inbound endpoints, review the Site Guest User separately. See Set up permissions and access.

Check subscription and services

Open Billing and start or refresh the subscription service as appropriate. Confirm a recent successful verification. If the subscription service stops or fails for any reason, Payloads stops operating after the seven-day recovery window expires.

Check Batch Engine and Job cleanup status if those services are used. CSV imports started from Flow need an authenticated Salesforce file connection; see Set up the Salesforce file connection.

Upgrade to v1.53

Test the upgrade in a sandbox before production. Preserve an export of important configuration and record representative request/response outcomes before changing the package.

After installation:

  1. Confirm the installed package version.

  2. Open an existing Payload and review its Actions workspace.

  3. Check that the required HTTP, Email or CSV lifecycle Actions are present and ordered correctly.

  4. Compare Queries, Targets, mappings, Credentials and request/response settings with the expected configuration.

  5. Test a representative run for each workflow and entry point your org uses.

  6. Check Billing, permission sets and asynchronous services.

The post-install migration converts legacy configuration to Actions. A visible Payload record alone does not prove migration completed correctly. If Actions or linked configuration are missing, use Check the upgrade to Actions and troubleshoot migration.

Do not rebuild or rerun production configuration blindly to clear a migration symptom. Preserve the affected records and error details for diagnosis.

Review behaviour after upgrade

Payload-level configuration now lives in Action detail panels. Credential, Endpoint, Method, Timeout and request content settings are under HTTP Request; response content and status policy are under HTTP Response.

Validate entry-point restrictions as well as visual configuration. Inbound firing mode determines whether the caller receives a final result or an early acknowledgement. General Flow Batchable execution rejects Actions Payloads with Target or Flow Actions. CSV has its own asynchronous runtime.

Move configuration between orgs

Use Export to obtain a .payloads file and Import in the destination Integration to apply it. API Names identify matching records; importing can replace existing child configuration.

The on-screen export preview redacts Credential secrets, but copied or downloaded exports can contain their original values. Store those files securely.

Before importing, prepare the destination’s objects and fields, Flow definitions, Sites, certificates and file-connection authentication. Review all referenced Action dependencies and test after import.

For the complete process and v1.53 dependency checks, see Export and import Integrations with Actions.

Complete the upgrade checks

Open a genuine new Job and inspect the Action timeline. Confirm the request, response, queried data, Target writes and any Flow or child Payload outputs. Check unsuccessful cases as well as the happy path.

Only treat the upgrade as complete when the configuration and runtime outcomes match the integration contract.

Did this answer your question?