Skip to main content

2 Way Sync: Webhooks API

What is a webhook?

A webhook is a method for one web application to provide real-time information to another application when a specific event occurs.

For example, a medicare agent might use a webhook to send their clients’ information directly from their CRM to MediZues. Webhooks can often be paired with triggers e.g. when a new contact is created in the CRM (that has a MBI and DOB), the contact is sent to MediZues.

Adding a contact to the workflow manually can also trigger the webhook to send data.

Spreadsheets vs. Webhooks

Both methods accomplish the same thing (transferring client data in and out of MediZues), however there are differences between the two.

Spreadsheet Webhook
Automation friendly No Yes
Importing 2000+ clients Slow and clunky at larger volumes Works like a charm
Exporting 2000+ clients Yes, to spreadsheet only Yes, send data to any other software
CRM compatible All CRMs Most, but not all. See Step-by-step tutorials below
Difficulty to setup Easy Medium

Do not use Zapier with MediZues.

Zapier is not HIPAA compliant and therefore cannot be used to pass Protected Health Information (PHI). Your clients’ MBIs are considered PHI and should not be used with Zapier. You can, however, use Zapier for handling non-PHI data.

Our friends at Keragon have developed a HIPAA-compliant alternative to Zapier, making it safe to use for handling PHI.

Documentation

MediZues requires 2 items to create a row in the Dashboard. (Each row pertains to 1 client):

  1. MBI (Medicare Beneficiary Identifier)
  2. DOB (Date of Birth)

Format: JSON

These two items can be labeled in various ways. Please check your CRM to determine the labeling of your custom fields. Below, you will find the labels that are compatible with MediZues.

Custom field label Works Doesn’t work Note
“MBI” x
“Medicare ID” x
“Medicare Number” x
“Medicare ID Number” x
“Medicare Beneficiary Indicator” x
“MBIs” x
“DOB” x
“Birth Date” x
“Date of Birth” x GoHighLevel’s default contact field called “Date of Birth” is automatically formatted as “Feb 3rd 1950”. MediZues cannot accept this format.

Watch this video for a tutorial on how to change the format to “02-03-1950”
Anything other than the above x Will create a blank row in MediZues
Acceptable custom fields and formats

The table below shows the acceptable formats for your custom field data. Ensure that your data is formatted according to one or a combination of the formats indicated as “Works.”

Field values Works Doesn’t work Note
MBI is filled, DOB is empty x
MBI is empty, DOB is filled x
MBI formatted as: 1234567890 x
MBI formatted as: 1234-567-8900 x
MBI formatted as: 1234 567 8900 x
DOB formatted as: MM-DD-YYYY x GoHighLevel’s default contact field called “Date of Birth” is automatically formatted as “Feb 3rd 1950”. MediZues cannot accept this format.

Watch this video for a tutorial on how to change the format to “02-03-1950”
DOB formatted as: MM/DD/YYYY x Importing via spreadsheet does not support this format but webhooks do!
DOB formatted as anything else x

API Key

Your MediZues account tab contains a unique API key that serves as an identifier, allowing MediZues to authenticate encrypted webhook requests, especially important when dealing with Protected Health Information (PHI).

You must authenticate the webhook using your API key using 1 of the following 2 ways:

  1. Include your API key in the webhook URL action, use the following format as a Header:

Key: medizues-api-key

Value: [insert your MediZues API key]

2. Appending “?medizues-api-key<yourAPIkey>” to the end of the webhook url.

For example, if your webhook url is “https://app.medizues.com/api/v1/patients/save-data/65159f”

and your API key is “123456”,

then the full url with the appended API key would be: “https://app.medizues.com/api/v1/patients/save-data/65159f?medizues-api-key=123456”

Trigger Ideas

Here are some ways that MediZues users trigger their CRM to send client data to MediZues:

  • Contact created
    • 2nd step: Wait > Wait For > Condition > MBI > Is not empty
    • 2nd step: Wait > Wait For > Condition > DOB > Is not empty
  • Pipeline Stage Changed
    • From “Prospect” to “Client”

To bypass the tigger, users can select the contacts within their CRM and manually add them to a workflow.