Create your first Payload
A Payload is the record that defines one interaction with an external system.
It might send a request from Salesforce, receive a request into Salesforce, expose Salesforce data through an API endpoint, process an inbound email, or refresh a credential.
Create the Integration first. Then create the Payload inside that Integration, so the Payload is grouped with the right Credentials, Transformations, Jobs, and related configuration.
If you have not created an Integration yet, start with Create your first Integration.
Before you start
Open the Integration that this Payload belongs to.
Decide what one action this Payload should perform.
Keep the external API documentation nearby if this Payload calls or receives data from an API.
Decide which Payload type best matches the action.
Do not try to make one Payload handle every API call for a system. A useful Payload has a clear job, such as Create Checkout Session, Get Customer, Receive Order Event, or Expose Payment Status.
Open the Integration record
Open the Payloads app, select the Integrations tab, then open the Integration that should own the Payload.
The Integration record contains the Payloads section. This is where you create and review the Payloads that belong to that external system or workflow.
Create the Payload
In the Payloads section, select New Payload.
Enter a clear Name.
Check the generated API Name.
Add a Subtitle.
Add a Description.
Choose a Payload type.
Select Save.
The Name should describe the specific action the Payload performs. Use names like Create Checkout Session, Get Customer, Receive Order Event, or Send Fulfilment Update.
The API Name is generated from the Integration name and Payload name. Treat it as a stable identifier once other configuration or automation starts using the Payload.
Use the Subtitle for a short summary of what the Payload does.
Use the Description for operating context: the external API endpoint, API documentation links, request and response notes, mapping behaviour, ownership notes, or anything a future admin should know before changing it.
Choose the Payload type
The Payload type controls which sections appear on the Payload record and what Payloads does at runtime.
For a detailed comparison, see Choose a Payload type.
Choose the type that matches the job:
Full Callout sends a request from Salesforce and can use the response to update Salesforce.
Outbound Webhook sends a request from Salesforce and can treat response status codes as success or failure.
API Push Into SF receives data from an external system and writes it into Salesforce.
API Pull From SF exposes Salesforce data for an external system to request.
Email Service receives inbound email and processes the email content in Salesforce.
Credential Payload maintains an access token or credential-related callout.
If you are not sure which type to choose, start from the direction of the data. If Salesforce starts the request, you are usually choosing Full Callout or Outbound Webhook. If the external system sends data into Salesforce, you are usually choosing API Push Into SF or Email Service.
Complete the first configuration
After saving, Payloads opens the new Payload record.
For Full Callout, Outbound Webhook, and Credential Payload types, Payloads opens the edit modal straight away because those types need extra runtime fields before they can run.
At minimum, check the fields that match the Payload type:
Endpoint: the URL Payloads calls, or the endpoint configuration used by the Payload.
Method: the HTTP method for callout-based Payloads.
Credential: the authentication record used when the external API needs one.
Outbound Content Type: the format Payloads sends out, such as JSON, XML, or form URL encoded data.
Inbound Content Type: the format Payloads expects back or receives in.
Response Failure Policy: how Payloads decides whether a response should fail the Job.
Job Cleanup: how long Jobs for this Payload should be retained.
Save the Payload once the required fields are complete.
The Payload record page shows the action buttons, key runtime fields, and the configuration sections that belong to the selected Payload type.
What to check
After creating the Payload, check that:
the Payload belongs to the correct Integration
the Payload name describes one clear action
the API Name is readable and stable
the Payload type matches the direction and purpose of the integration step
the required runtime fields are complete
the right configuration sections appear on the Payload record
If Payloads shows Payload name already in use, choose a more specific Name and save again.
Next step
Configure the Payload details that match the type you selected.
For a callout Payload, that usually means adding the outbound body, headers, parameters, queries, modifiers, and any Credentials or Transformations it needs. For an inbound Payload, it usually means configuring the inbound body, headers, parameters, targets, and target fields.