Return Data Overview

You can enhance your declarative Foundations integrations by adding return data to your configuration.

Return data helps you to confirm that data has been transferred between your applications.

Return data enables a subscribing application to publish a response when it receives a message from another app. The app that published the original message can subscribe to the delivery response and display the following information on source records:

  • A lookup to the linked target record
  • A status field to show whether the message delivery was successful
  • An errors field to store details of any errors that occurred
Tips:

Return data is supported for any messaging relationships that contain a standard subscription type.

Return data also includes a lookup to the source record on the target object, which you can show on the target if required. This is created by default, unless a lookup to the source object is already specified as the identifier reference.

If your org contains bidirectional integrations to keep record details in sync, you can enable return data for both message types. This enables you to send back details for each side of the integration.

Status and error information is also available from the Messages related list on the message type, but return data enables you to see these details directly on the relevant records.

When you enable return data, Foundations automatically generates the following information:

  • Unique return data developer names for the relevant declarative publications and subscriptions if they do not already exist
  • Return data fields on the relevant source and target objects (including any child objects specified in the mappings)
  • A return data message type
  • Return data publications and subscriptions

When enabled, return data details are displayed below relationship mappings. The Return Data Details section includes information about the source and target of the return data and the mappings included.

You can view a return data relationship directly from the Message Types tab, but we recommend that you view return data from the relationship it relates to.