Webhook Guide

Spark Webhooks are a new feature that allows you to unidirectionally sync your contact information to your supported 3rd party platform of choice! This guide will explain how to add a webhook using the GoHighLevel (GHL) platform.

Adding a Webhook using GoHighLevel (GHL)

First, navigate to your account in GHL.

On the left-hand side, click on Automation.

Then, click on +Create Workflow and select Start from Scratch.

You will be greeted by a New Workflow page.

Feel free to name your workflow using the pencil icon at the top. From here, click +Add new Trigger.

We will be adding an Inbound Webhook trigger. Select it from the list.

Take note of the URL field. Copy the URL and head over to the Spark platform.

Click the gear icon on the bottom left of the platform page to access the Spark Settings page.

Click on Platform data.

Your screen should include a Webhook section. Click on Add webhook URL.

A modal will pop up asking for the URL we copied over from GHL. Paste it in the box.

Read the disclaimer and check the box in order to be able to submit your webhook URL.

Once submitted, your webhook URL will appear on the main page.

We can send a test payload to GHL in order to map data between systems. Click on Test URL.

If set up correctly, you should be alerted that the test was successful. A Verified badge will appear next to the Webhook subtitle.

Back in GHL, hit the “Fetch Sample Requests” button on the bottom.

Select the test payload that we sent.

You should see the reference payload with sample information. This will be our mapping reference.

If everything looks in order so far, go ahead and click the “Save Trigger” on the bottom right.

Next, you will be brought to the Action creation page. We will be making a Create Update Contact action.

Click the Add field button and start mapping the fields in your GHL platform to the fields provided by the sample payload. You can select the payload fields by clicking the button to the left of the Trash icon.

Once you are done mapping everything, click Save Action.

After that, we are done!

Click Save in the top right corner, and click the Draft switch to Publish to activate your workflow. Now, whenever a contact or their policies are updated in Spark, they will be updated in your 3rd party platform as well!

Creating New Fields in GHL

The Spark webhook payload comes with many fields not set by default in platforms like GHL. In order to create new fields in GHL, click on Contacts on the left-hand side of the platform page, followed by the gear icon on the center top. Click on Add field.

Here is the complete Spark webhook payload. Below we will denote any multi-choice fields. We currently support 4 policies each for Active, Pending, and Plan exit categories.

📢

Note: For those enrolled in our BEQ feature, Policies will indicate whether or not they have been validated through BEQ.

{
  "details": {
    "id": 1234,
    "first_name": "Anthony",
    "middle_name": "John",
    "last_name": "Soprano",
    "preferred_name": "Tony",
    "full_name": "Anthony Soprano",
    "full_preferred_name": "Tony Soprano",
    "home_phone": "201-555-1234",
    "mobile_phone": "201-555-5678",
    "email": "tony@baronesanitation.com",
    "home_address": "14 Aspen Drive, North Caldwell, NJ 07006",
    "shipping_address": "241 Calcutta Street, Newark, NJ 07114",
    "sex": "Male",
    "gender": "Male",
    "point_of_contact": {
      "full_name": "Carmela Soprano",
      "relationship": "Spouse",
      "home_phone": "201-555-1234",
      "mobile_phone": "201-555-2468",
      "email": "carmela.soprano@aol.com"
    },
    "agent": {
      "first_name": "Dwight",
      "last_name": "Harris",
      "full_name": "Dwight Harris",
      "office_phone": "201-555-5555",
      "email": "dwight.harris@fbi.gov"
    },
    "primary_contact": "Beneficiary",
    "preferred_language": "en",
    "needs_assessment_link": "https://example.com/needs-assessment"
  },
  "phi": {
    "dob": "1959-08-22",
    "active": {
      "policy_1": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_2": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_3": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_4": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      }
    },
    "pending": {
      "policy_1": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_2": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_3": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_4": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      }
    },
    "plan_exits": {
      "policy_1": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_2": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_3": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      },
      "policy_4": {
        "name": "AARP Medicare Advantage from UHC OH-0015 (PPO)",
        "bid_id": "H8768-037-1",
        "carrier": "UnitedHealthcare",
        "effective_date": "1999-01-10",
        "expiration_date": "2007-06-10",
        "beq_status": "Accreted App"
      }
    }
  }

Webhook Guide
Adding a Webhook using GoHighLevel (GHL)
Creating New Fields in GHL