Overview

Merge standardizes third-party data through our Common Models, but you may need additional information beyond what those models expose. Merge offers four supplemental data mechanisms — Remote Data, Authenticated Passthrough Requests, Field Mappings, and Remote Fields — so you can access the extra fields, raw responses, or custom data your use case requires.

What are the supplemental data types?

• Remote Data — Use when you need an extra field from an endpoint that Merge already calls but that isn't part of the standardized Common Model response. Returns the original third-party payload alongside Merge's Common Model fields, so you avoid an additional API request to the integration. See Remote Data.

• Authenticated Passthrough Requests — Use when you need data from an endpoint that Merge does not call. Requests are sent directly to the integration's API in that integration's native format (not Merge's unified format), ideal for fetching data outside Merge's Common Models. See Passthrough Requests.

• Field Mappings — Use to map custom fields and other non-mapped data from your users' platforms to target fields on your Merge Common Models. You or your end users can create Integration, Organization, or Linked Account level mappings from the Advanced section of the Merge Dashboard. See Field Mappings.

• Remote Fields — Use to access standardized metadata about fields included in Remote Data, push values for custom fields back to an end user's platform, or pull custom fields back in a standardized way. Remote Fields metadata includes field type (string, bool, number, etc.), string formats, available options, display name, and whether the field is custom to an account or standard to the third party. See Remote Fields.

Which one should I use?

• Need a field from an endpoint Merge already calls? Use Remote Data.

• Need data from an endpoint Merge does not call? Use Authenticated Passthrough Requests.

• Need to map custom fields into your Common Model shape? Use Field Mappings.

• Need metadata about a custom field, or to write back custom field values? Use Remote Fields.

Who should I contact for help?

If you have questions about enabling Field Mappings, Remote Fields, or remote_data on your account, reach out to us at [email protected].