Third-party webhooks sent to Merge
When an event occurs in a third-party platform, such as a change to end user data, that platform can be configured to send Merge a webhook with a data payload to give you real-time updates regardless of the rate at which Merge syncs data.
Follow the setup instructions below to enable Merge to receive third-party webhooks for a linked account.
Merge is able to automatically create webhooks in supported third-party APIs to alert Merge of changes. This means neither you nor your end user needs to do the manual setup of a webhook per Linked Account. See what integrations support automatic webhook creation.
Automatic webhooks are created on Merge’s initial sync with a third-party platform.
Automatic webhooks are not enabled by default. To enable automatic webhooks, go to Advanced > Webhooks > Third Party in your dashboard to toggle this feature on.
To enable / disable webhooks for a specific Linked Account, go to the Webhooks tab under a specific Linked Account.
You will see a purple notice that says Merge automatically created this webhook in [App Name].
Enable or disable the Merge receiver (an endpoint in Merge’s API that receives third-party data) to control whether Merge updates your data with payloads from the connected app’s webhooks.
There are a few third-party applications that do not support automatic webhook creation via API, but do support manual webhook creation via UI. See what integrations support automatic webhook creation.
The only way to set up webhooks for these integrations is:
- Have your end user manually configure the webhook subscriptions in their third-party app instance.
See our Help Center for guides to configure webhooks in the third party.
- Manually configure third-party webhooks in Merge
Navigate to Linked Accounts and select an account integrated with a third-party platform that supports third-party webhooks.
Go to the Webhooks tab of the Linked Account to:
- Access the Merge Receiver URLs and Signature Keys
- Configure which events Merge will listen to
Once your webhooks are configured, the third-party application will send webhooks to the Merge Receiver URLs.
For each webhook request, Merge will immediately process the incoming data and save the updated model(s).
Webhooks will be sent from Merge to your system for all relevant Merge Webhooks you have set up, allowing real-time updates to flow from the third-party app all the way to your system.