Merge Docs
Custom Fields
Overview
Merge allows your users to map custom fields from the platforms they use to your Merge Common Models. While Merge normalizes as much as possible for a unified experience, we know not every piece of data fits neatly in to our schema. Custom Fields are an intuitive way to access product or platform specific data while taking full advantage of the Merge Unified API.
Custom Fields operates in three distinct parts, reflected in the following sections of this guide:
Add custom fields to your Merge Common Models
Find Custom Fields in your Merge Dashboard (under Configuration).
Press Add custom field for the Common Model you want to add a custom field to. The custom field you define will later be returned in the object response from Merge.
Add a name for your custom field as you want to access it within Merge’s Unified API. We recommend using underscores in your field name (e.g., technical_assessment_score, etc.).
Press Add Custom Field to save your custom field.
Your user maps custom fields via Merge Link
After adding custom fields to your Merge Common Models, your user can now use Merge Link to map custom fields from the platform they want to integrate to Merge.
After your user authenticates their integration in your Merge Link component, they will be prompted to map a custom field.
If they select Skip for now they will be able to map their custom fields later by re-authenticating their integration.
If they select Map Custom Fields, your user will begin the process of mapping your fields to their platform. For each custom field, they will be given a single screen (such as the one below).
Access custom field data through Merge’s Unified API
After adding custom fields to your Merge Common Models, your user can now use Merge Link to map custom fields from the platform they want to integrate to Merge.
After your user maps, custom field data will be automatically accessible in the Common Model object (e.g., Application, Candidate, etc.) returned from the Merge API. No parameters are needed.
The below is a sample request to the application’s endpoint after mapping is complete.
