Skip to main content

Choose a Payload type

Understand the current Payload types and choose the right starting point for an integration step.

Choose a Payload type

The Payload type tells Payloads what kind of integration step the Payload represents.

It controls which configuration sections appear, which runtime behaviour is available, and what Payloads expects to do when the Payload runs.

If you are creating your first Payload, start with Create your first Payload.

New Payload modal showing the current Payload type choices

The New Payload modal shows the current starting types: Outbound, Inbound, Email Handler, and Credential Payload.

Start with the direction

Most Payload type decisions start with one question: who starts the interaction?

If Salesforce starts the interaction, choose Outbound.

If another system starts the interaction over HTTP, choose Inbound.

If the interaction starts with an email message, choose Email Handler.

If the Payload exists to maintain authentication, it will usually be a Credential Payload created automatically for a Bearer Token Credential.

Outbound

Use Outbound when Salesforce sends a request to another system.

This type is a good fit when you need to:

  • send Salesforce data to an external API

  • send an event-style webhook

  • include headers, URL parameters, or URL modifiers

  • build a JSON, XML, or form URL encoded request body

  • read the API response when the response matters

  • write response values back into Salesforce when needed

Common examples include creating a checkout session, notifying a fulfilment system, creating a customer in an external platform, or sending an order update.

An Outbound Payload can be simple or detailed. If the response body is not important, treat the response status as the delivery result. If the response contains data Salesforce needs, model the Response body and Data Targets.

For setup steps, see Configure an Outbound Payload.

For a simple webhook-style example, see Configure an outbound webhook.

Inbound

Use Inbound when another system sends a request to Payloads.

This type is a good fit when you need to:

  • receive webhook-style API requests from another system

  • parse inbound JSON, XML, or form URL encoded content

  • read inbound headers or URL parameters

  • create or update Salesforce records from the request

  • return Salesforce data to the caller

  • avoid building a custom Apex REST endpoint for a focused integration use case

Common examples include receiving payment events, accepting order updates, returning payment status, or exposing a small Salesforce-backed response to a portal.

An Inbound Payload has a Request side and a Response side. Use Data Targets when the request should write data into Salesforce. Use Data Queries and Response Body elements when the caller should receive Salesforce data back.

For write-focused setup steps, see Configure an Inbound Payload that writes to Salesforce.

Email Handler

Use Email Handler when the inbound event is an email rather than an HTTP request.

This type is a good fit when you need to:

  • receive emails into Salesforce

  • read the email subject, sender, body, or attachments

  • map email content into Salesforce records

  • support systems that can send email but cannot call an API

Common examples include processing billing emails, supplier notifications, support updates, or mailbox-based operational messages.

Email Handler Payloads usually need Email Contents, Data Targets, and at least one Email Service record.

Credential Payload

Use Credential Payload when the Payload exists to maintain authentication for another Payload.

You should not normally create this type manually. Payloads creates Credential Payloads automatically when you create a Bearer Token Credential that needs a token refresh flow.

This type is a good fit when you need to:

  • call an authentication endpoint

  • refresh an access token

  • read token values from an authentication response

  • update the related Credential from the response

Common examples include OAuth token refresh flows.

For setup steps, see Configure a Credential Payload.

Quick choice guide

Choose Outbound when Salesforce sends a request.

Choose Inbound when another system calls Payloads over HTTP.

Choose Email Handler when the inbound message is an email.

Use the generated Credential Payload when the Payload supports authentication rather than a business process.

What to check

Before you save the Payload, check that:

  • the type matches who starts the interaction

  • the type matches whether data is moving into Salesforce, out of Salesforce, or both

  • the Payload name describes one clear action

  • the Integration has the Credentials and Transformations the Payload may need

  • the required sections appear after saving

If the visible sections do not match what you expected, check the Payload type first. The type is what determines which configuration areas Payloads shows.

Did this answer your question?