Overview

In Payloads, the Integration object is the main object we use to contain all configuration related to whichever external system we're connecting to. In this case, we are going to use an integration with Stripe as an example.

The integration page is where you will find all configurations & jobs related to the integration.

Core Sections

At the top we have the standard Highlights Panel, with the main section of the page containing tabs for our Payloads, Jobs, APIs & Emails, Credentials & History.

In the Highlights Panel you can edit or delete the Integration, as well as use our migration functionality to import or export Integrations between environments.

As you explore the page, you'll find a section of tabs that we are discussing below:

Payloads

This section provides an overview of the Payload configurations in this Integration, both inbound & outbound.

Inbound Payloads

Inbound Payloads are data packets received from Stripe into Salesforce. They can either be sent directly from Stripe to Salesforce (via a Webhook for example), or they can be used as response handlers where we want to take the response from an Outbound Payload and save it back to a record in Salesforce.

They represent the various types of data that Stripe sends over to Salesforce. Here are the specifics:

Name: The name of the Payload. For instance, Customer: Created / Updated (Webhook) likely pertains to a callout from a Stripe webhook that creates or updates an Account record in Salesforce.
Content Type: This denotes the format in which the data is being sent. In the provided example, the content type is JSON.
# Targets: Represents the number of target records in Salesforce where the inbound data will be saved to.
Allow Partial Success: If enabled, it means that the Payload will success even if some of the Target records do not save successfully.

Outbound Payloads

Outbound Payloads are data packets sent from Salesforce to Stripe. These payloads indicate the kinds of data that Salesforce communicates back to Stripe. Here are the specifics:

Name: The name of the Payload. Customer: Get All (Request) suggests that Salesforce might be requesting customer details from Stripe.

Record Type: This signifies the initiation source of the outbound request. In this instance, Salesforce Initiated indicates that the request to fetch order details is initiated from Salesforce's end. API Initiated Payloads are used by other systems to fetch data from Salesforce using GET requests.
Content Type: Specifies the data format. In this case, it's FORM URL Encoded, indicating uniformity in the data interchange format for both inbound and outbound transactions.
# Sources: Represents the number of data sources from which the outbound payload pulls information before sending it to Stripe.
Endpoint: This is the URL to which Salesforce sends its HTTP request. The provided endpoint URL seems to fetch order details for a specific customer and product from Stripe.
Method: Indicates the type of HTTP method used for the request. Here, it’s GET, which means Salesforce is requesting data from Stripe.

Jobs

A log of all calls made (both inbound & outbound) can be found here. Every activity associated with the payloads gets registered, offering a centralized view for users.

In the context of this Stripe integration, Jobs tab acts as a central repository for all the activities or calls made between Salesforce and Stripe.

Here's a deeper look into the functionalities and features of the Jobs section:

Inbound Payload Jobs

Inbound Payload Jobs are activities or calls made from Stripe to Salesforce. They provide insights into the data being sent to Salesforce. The details include:

Job Number: A unique identifier for each job.
Inbound Payload: The Inbound Payload this data was sent to.
Status: Status of the job. The status Completed indicates a successful data transfer.
Last Modified Date: Timestamp showcasing when the job was last updated or modified.
# Records Processed: Indicates the number of records successfully processed.
Source: The origin of the data, which in this example is an External API.

Outbound Payload Jobs

Outbound Payload Jobs pertain to the activities or calls made from Salesforce to Stripe. The details include:

Job Number: Each outbound job has a unique identifier, like OUT-28 and OUT-29.
Outbound Payload: The Outbound Payload used for this outbound call.
Status: Status of the job.
Last Modified Date: The timestamp indicating the most recent update or modification to the job.
Response Details: Additional columns seem to provide response codes and messages, offering insights into the outcomes of the data transfer. For instance, a response code 200 with a message OK typically signifies a successful data operation.

APIs & Emails

Payloads allow you to set up both external REST API endpoints & unique email addresses which can be used to send or pull data from Payload configurations.

This tab caters to two functions:

External APIs: REST endpoints that Payloads can expose externally, allowing other systems to either POST data to an Inbound Payload, or GET data from an Outbound Payload.
Email Services: Tailored for email handling. Salesforce users can create unique email addresses to receive emails directed towards inbound payloads. A practical application would be routing inbound emails from a support queue to a custom Salesforce object.

Credentials

This tab shows a list of Credential records for the given Integration. Credentials are used by Outbound Payloads to authenticate into other systems, in this case Stripe.

This tab is where authentication details, like usernames, passwords, OAuth credentials, client IDs, and client secrets, are stored.

History

Maintaining transparency and accountability, the history tab logs changes made to the integration record. Be it a name alteration or any other modification, the audit history ensures that every action is tracked and recorded.

What is Payloads?

Integration Record Page