Overview
Merge is a single platform to deliver an entire category of customer facing integrations. Developers integrate once with Merge to offer a full category of integrations and easily maintain integration health.
Below are a few simple steps to get started!
Step 1: Create an Account
You can create an account and get started for free today!
Step 2: Connect a sandbox for testing
Creating a Merge accounts, gives you the ability to link any of our 200+ integrations. You can use our Mock Sandbox to test making API requests and seeing our unified API responses immediately.
We recommend the following platforms as they offer free trials and are very popular.
HRIS: BambooHR
ATS: Workable
Ticketing: Jira
CRM: Hubspot
Accounting: Quickbooks
Enterprise platforms like Workday, ADP, or SAP SuccessFactors don't have public sandbox access. To get access and support for these platforms, inquire about our Professional or Enterprise Plans.
Step 3: Create your first Linked Account
A Merge Linked Account represents a connection between your application and your users third-party platforms. A Linked Account is always associated with exactly one Merge integration.
There are three ways to connect your first Linked Account. The first two don't require you to write any code, you can get started immediately!
Create a test Linked Account. Test Linked Accounts are not billed! Test linked accounts will start the initial sync automatically, but subsequent syncs will need to be triggered manually from the Merge dashboard.
Use Magic Link to deliver an in-browser Link experience. Click "Create production Linked Account" from your Merge Dashboard. Learn more in our guide.
Embed Merge Link in your application. This allows your users to create integrations completely on their own. This also allows you to customize the linking experience.
After you've successfully connected a Linked Account, data will automatically start syncing! This can take a few minutes to a few hours depending on the volume of data and third-party API limitations.
Step 4: Test your integration
When making requests to the Merge API, there are two primary authentication protocols. A Merge API Key and a Linked Account Token. Linked here, is our developer API documentation.
Our pre-built API Tester is the easiest way to make requests to Merge's APIs or to the APIs of supported third-party platforms. We automatically fill in the Merge API Key and Linked Account Token.
Step 5: Keep your database up to date
There are two ways of data sync to keep in mind.
Syncs between Merge and the third-party platform
Syncs between your application and Merge
Merge and the third-party platform
Merge automatically syncs data for production Linked Accounts on a daily basis. We also offer faster sync frequencies for our Professional and Enterprise customers. See our integration sync frequencies page to learn more.
Syncs between your application and Merge
In order to keep your application up to date with Merge's data see our guide on syncing data. When syncing data with Merge, we recommend a combination of Merge webhooks and polling.
Important endpoints
/sync-status: Returns data on the sync status of a linked account
/linked-accounts: Returns available operations for an integration
/integrations: Returns meta-data about a specific integration
Congratulations!
You have completed the basics of getting started with Merge. We are excited to be powering your customer facing integrations. If you need further support, please reach out at [email protected].
Here are some other popular Help Center articles.