Skip to content
Unlock Health Logo

Setting up a Universal Webhook Integration

If you need to send HRA completion data to a third-party system—like a CRM, marketing automation tool, or internal database—and don’t see a standard integration listed, the Universal Webhook is your go-to option.

This integration allows your team to securely and automatically receive patient-level data in real time, even if a native integration isn’t available.

📹 Watch the full video walkthrough on setting up a Universal Webhook


When to Use the Universal Webhook

Use this integration when:

  • You’re connecting to a custom endpoint
  • You’re using a middleware tool (e.g., Zapier, Make, or Mulesoft)
  • You want a flexible alternative to a standard integration
  • You’re sending data to a system we don’t currently support natively

How It Works

When an HRA is completed, the webhook sends a JSON-formatted POST request to your specified endpoint (called the “webform URL”).

The payload contains:

  • All standard HRA fields
  • Any custom questions captured
  • Tracking metadata (e.g., UTM parameters, HRA ID, risk report URL)

💡 Universal Webhook Documentation

 💡Sample of JSON code sent via the API


How to Set It Up

  1. Go to the Integrations tab in the HRA Console
  2. Click Add Partner Integration
  3. Select Universal Webhook at the bottom of the list
  4. Choose your report template:
    • Standard Template – includes all fields, metadata, and custom questions
    • HG Mercury Template – simplified legacy format

📸 (Screenshot: Integration modal showing templates)

webhook1

  1. Paste in your webform URL (this is your system’s endpoint URL)
  2. If sending data to a third-party platform, select Yes, provide the platform name, and confirm that your organization has a Business Associate Agreement (BAA) in place
  3. Click Save Integration

Activating the Integration

Once saved:

  • Go to the HRA’s Follow-Up Plan
  • Click into the Integrations module
  • Toggle on the Universal Webhook you just created
  • Click Publish to make it live

💡Learn more about enabling integrations in Follow-Up Plans 


Data Dictionary Access

To see the full field list:

  • Request it from your Client Success Director
  • Or generate a Raw Data Report from the console to view available fields per HRA

💡 Generating Raw Data Reports


Best Practices

  • Always confirm that your endpoint is:
    • HTTPS-secured
    • Able to receive JSON POST requests
    • Configured to parse the expected payload structure
  • Test your connection with a sample payload
  • Confirm your BAA is in place before sending PHI to third-party systems


 If you’d like to learn more, check out these resources:


If you need any help navigating the HRA Management Console or have features you wish to see added, don’t hesitate to contact your Client Success representative!
Email: hrasupport@unlockhealthnow.com