Following the next steps, we will show how to add custom field response values to a Unify response.
The term "custom fields" is used to describe fields that are created by the user in the integration.
Let's take the example of mapping a "T-shirt Size" to be shown as part of the Unify response, to send them some goodies and a t-shirt.
1. Configure a response key field
Navigate to Configuration > Custom Mapping
https://platform.apideck.com/configuration/crm/custom-mapping
Choose the specific API for which you want to add a response mapping.
Click "Create Mapping" to add a new response field.
Provide a unique "Key" and a descriptive "Name." Optionally, add a brief "Description." The "key" will be utilized in the API response.
2. Map a property for an integration
The new field can be mapped for 1 or multiple integrations. Select the desired integration (e.g., Hubspot) to which you want to add the extra response field.
In our example case, we want to map a custom field value from the API response from Hubspot, which is a custom field defined by the Consumer.
Done, now it is up to the Consumer to select the correct field.
If you genuinely need a specific field to be mapped by the consumer, you can mark it as required
.
3. Consumer maps the custom field
The "T-shirt size" is a custom field that is configured by the consumer in their Hubspot instance.
To be able to have the "T-shirt size" available in Unify for their integration, the consumer will have to map the custom field.
Open up Vault
Goto the field mapping option
Click on “Map field" button to get started with the mapping.
Click on "Edit" to start the mapping.
Navigate through the list of available custom fields to find the field that contains the value for the "T-shirt Size".
Save field mapping
The consumer is done
4. Use the mapping
The mapping is now configured, and the "T-shirt size" field will be returned in your API response as "custom_mappings.tshirt_size
".
REMARK: Note that the "tshirt_size" field will be included in the response only if a value is returned by the Hubspot integration.