Use a Field Mapping User Setting to allow your users to define a mapping between objects in your application and their integration.
Navigate to Customize Connect Portal
Select the Field Mapping Input Type
Configure the Setting
Add Field Labels
paragon.connect
to render the Field Mapping in the Connect Portal in your frontend application.
Left: Pre-configured Field Mapping Input. Right: Field Mapping Input
paragon.connect
call by rendering pre-built dropdowns for the most common object types and fields for you.Toggle Dynamic Fields
Provide Object Name
paragon.connect
in the Passing Dynamic Fields through the SDK section.Edit Example Fields for Testing in the Workflow Editor (Optional)
Save Changes
paragon.connect
method in your frontend to fully configure the Integration Objects, Integration Fields, and Application Fields that are rendered dynamically in the Connect Portal.
Pre-configured Field Mappings simplify the SDK call by pre-building dropdowns for the most common object types and fields for you and minimally require you to specify your Application Fields in the SDK. You can think of this as the right-hand-side of the Field Mapping input.
For all other integrations, you must define the Integration Objects, their Integration Fields (the left-hand-side of the Field Mapping input), and your Application Fields.
mapObjectFields
option, with an object keyed by the name you specified in the “Object Name” field when configuring your setting:
label
: The human-readable description for the field. This will be shown to the user in the Field Mapping input.value
: The field key used by the object as it exists in your application. This key does not yet support nested properties.objectTypes
and integrationFields
properties and their get
methods to render either a static list of objects and their fields, or a paginated list of objects and their fields via an API request.
objectTypes
— defines the list of record types available in the user’s integration (e.g. “Contact”, “Deal”, “Opportunity”).integrationFields
— defines the fields available for the selected record type.get
method that must return either:
{ label, value }
pair as defined above in Passing Application Fields for a Pre-configured Field Mapping example, orparagon.connect
call to explicitly define the applicationFields
property.
applicationFields
defines the list of fields from your application. It should contain a fields
array containing { label, value }
pairs identical to the fields
array in the Passing Application Fields for a Pre-configured Field Mapping example.
The following are examples of how to fully configure objectTypes
, integrationFields
, and applicationFields
when passing your own object types and fields:
userCanRemoveMappings
option alongside the fields
array in your paragon.connect
call.
fields
. This option can be combined with the defaultFields
option to achieve different display configurations:
{ userCanRemoveMappings: true, defaultFields: [] }
{ userCanRemoveMappings: true, defaultFields: ['title'] }
defaultFields
is an array of strings matching the value
property of your fields
. Any fields with matching value
keys will be included in the initial list of Field Mappings that your user sees, when viewing the Connect Portal for the first time.
If defaultFields
is unspecified, all fields specified in the fields
property will appear in the initial list of Field Mappings.
fields
:
Configure the test data for the Field Mapping input
originalPayload
: This is the original App Event or Request payload received by the trigger.mappedIntegrationObject
: This is the Integration Object that was mapped based on the Field Mapping configured in the Connect Portal.originalPayload
: This is the original Integration Object received by the trigger.mappedApplicationObject
: This is the Application Object that was mapped based on the field mapping configured in the Connect Portal.