Create your first Integration
An Integration is the top-level record for one external system, API, or business process.
It is not the individual API call. It is the place where you group the Payloads, Credentials, Transformations, and Jobs that belong together.
For example, you might create one Integration called Stripe Commerce Operations, then add separate Payloads for creating customers, fetching charges, handling payment events, and updating Salesforce records.
Create the Integration first. The other records need somewhere sensible to live.
Before you start
Make sure you can open the Payloads app.
Make sure your user can create Integration records.
Decide what external system or workflow this Integration represents.
Keep the external API documentation nearby if you have it.
If you are still getting familiar with the app, start with Introduction to Payloads.
Open the Integrations tab
Open the Payloads app, then select the Integrations tab.
The Integrations tab shows each existing Integration, with its related Payloads, Credentials, and Transformations.
The Integrations tab is where you create new Integrations and review the configuration already grouped under each one.
Choose the right scope
Before selecting New Integration, decide what this Integration should cover.
A good Integration usually represents:
one external platform, such as Stripe, ServiceNow, Shopify, or NetSuite
one business workflow, such as order intake, fulfilment updates, customer onboarding, or case escalation
one set of related API calls that share credentials, mappings, and ownership
Avoid creating a separate Integration for every API endpoint. If several Payloads belong to the same external system or operational process, keep them under the same Integration.
Also avoid making one Integration so broad that nobody can tell what it owns. Customer Portal Sync is useful. APIs is not.
Create the record
Open the Payloads app.
Select the Integrations tab.
Select New Integration.
Enter a clear Name.
Check the generated API Name.
Add a Subtitle.
Add a Description.
Select Save.
The Name should be something an admin or support user can recognise later, without needing to know the implementation. Use names like Stripe Commerce Operations, ServiceNow Case Escalation, or Warehouse Fulfilment Updates.
The API Name is generated from the Name and cannot be edited directly in the modal. Treat it as a stable identifier once the Integration is in use.
Use the Subtitle for a short summary. This appears beside the Integration name on the record page.
Use the Description for useful operating context: what the Integration is for, which external API it talks to, links to API documentation, owner notes, environment details, or anything a future admin would need when maintaining it. URLs in the Description appear as links on the Integration record.
After saving
Payloads opens the new Integration record after it is saved.
From there, you can add:
Payloads for the API calls or inbound requests this Integration needs
Credentials for authentication
Transformations for changing values between Salesforce and the external API
You can also use the Jobs action on the Integration record to review recent Jobs for that Integration.
What to check
After creating the Integration, check that:
the Integration name is clear enough for another admin to understand
the generated API Name is unique and readable
the Subtitle explains the Integration in one short line
the Description gives enough context to maintain the Integration later
the Payloads, Credentials, and Transformations sections are visible on the record page
If Payloads shows Integration name already in use, choose a more specific Name and save again.
Next step
Create the first Payload under the Integration.
Start with one API interaction, get it working, then add the rest of the Payloads, Credentials, Transformations, and mappings that belong to the same Integration.