How to Configure the Webhook Directly

How to Configure the Webhook Directly

​
Integrate our data with any system you like! Webhook Notifications (per user, available to all users)

Data Format

  1. JSON  - (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate.
  2. Your application will need to be capable of receiving JSON.

Location in Application

  1. Login to your dashboard
  2. Go to 'Configuration -> Users'
  3.  We recommend creating a New User for Webhooks only







Step 1:

Edit User ->Other Integration  







Step 2.

Enable the Webhook by clicking the checkbox and inserting the postback URL







Step 3.

Update User after you click 'Test Postback Now'







Fields Available

This integration is useful for connecting Franchise Ninja with other systems.  When your site receives new traffic, instead of sending an email alert, a Webhook will be sent in JSON with the following fields available to map into your system. 

first_name
last_name
personal_email
contact_address
contact_address_2
contact_metro_city
contact_state
contact_zip
contact_zip4
gender
age_range
married
children
income_range
net_worth
homeowner
contact_job_title
contact_professional_email
contact_linkedin_url
contact_facebook_url
contact_twitter_url
company_name
company_linkedin_url
company_domain
company_employee_size_range
company_employees
company_revenue_range
company_primary_industry
company_address
company_address_2
company_city
company_region_code
company_postal_code
session_date
remotesessionid
referrer
visitor_first_visit
visitor_search_term
visitor_search_engine
campaign_name
campaign_source
campaign_medium
campaign_term
campaign_content
pages_visited
full_url
host_name
page
querystring
anchor
page_time
visit_date


Notes
Instant email notifications must be turned on to trigger the push. 







Example JSON Output


  1. {
  2.    "first_name":"Joe",
  3.    "last_name":"Somebody",
  4.    "personal_email":"joesomebody@gmail.com",
  5.    "contact_address":"222 Personal Address Road",
  6.    "contact_address_2":"Apt. 111",
  7.    "contact_metro_city":"Jacksonville",
  8.    "contact_state":"FL",
  9.    "contact_zip":"32256",
  10.    "contact_zip4":"1234",
  11.    "gender":"Male",
  12.    "age_range":"35 - 44",
  13.    "married":"false",
  14.    "children":"false",
  15.    "income_range":"$90,000 to $119,999",
  16.    "net_worth":"$150,000 to $249,999",
  17.    "homeowner":"false",
  18.    "contact_job_title":"Director of Sales",
  19.    "contact_professional_email":"somebody@companydomain.com",
  20.    "contact_linkedin_url":"linkedin.com/someperson",
  21.    "contact_facebook_url":"facebook.com/somevisitortoyoursite",
  22.    "contact_twitter_url":"twitter.com/somevisitortoyoursite",
  23.    "company_name":"SomeCompanyName",
  24.    "company_linkedin_url":"linkedin.com/company/somecompanyname",
  25.    "company_domain":"companydomain.com",
  26.    "company_employee_size_range":"51-200 employees",
  27.    "company_employees":57,
  28.    "company_revenue_range":"$50 - 100M",
  29.    "company_primary_industry":"Marketing And Advertising",
  30.    "company_address":"111 company address",
  31.    "company_address_2":"Suite 105",
  32.    "company_city":"Jacksonville",
  33.    "company_region_code":"FL",
  34.    "company_postal_code":"32256",
  35.    "session_date":"2022-12-19T11:39:33.2038487-05:00",
  36.    "remotesessionid":"alksdjfkly76y234sdaifkjhjajoiuasf234",
  37.    "referrer":"www.google.com",
  38.    "visitor_first_visit":true,
  39.    "visitor_search_term":"myTerm",
  40.    "visitor_search_engine":"www.google.com",
  41.    "campaign_name":"monthly newsletter",
  42.    "campaign_source":"monthly_newsletter_volume1",
  43.    "campaign_medium":"email",
  44.    "campaign_term":"free upgrade",
  45.    "campaign_content":"campaign content",
  46.    "pages_visited":[
  47.       {
  48.          "full_url":"https://www.somewebsite.com/testdir/testpage.html#anchorText?testqs=abcde",
  49.          "host_name":"www.somewebsite.com",
  50.          "page":"/testdir/testpage.html",
  51.          "querystring":"testqs=abcde",
  52.          "anchor":"anchorText",
  53.          "page_time":63,
  54.          "visit_date":"2022-12-19T11:24:33.2038487-05:00"
  55.       },
  56.       {
  57.          "full_url":"https://www.somewebsite.com/testdir/testpage2.html",
  58.          "host_name":"www.somewebsite.com",
  59.          "page":"/testdir/testpage2.html",
  60.          "querystring":"",
  61.          "anchor":"",
  62.          "page_time":22,
  63.          "visit_date":"2022-12-19T11:24:55.2038487-05:00"
  64.       },
  65.       {
  66.          "full_url":"https://www.somewebsite.com/testdir/testpage3.html",
  67.          "host_name":"www.somewebsite.com",
  68.          "page":"/testdir/testpage3.html",
  69.          "querystring":"",
  70.          "anchor":"",
  71.          "page_time":22,
  72.          "visit_date":"2022-12-19T11:25:17.2038487-05:00"
  73.       }
  74.    ]
  75. }



Alert
Note: Basic custom development knowledge required. Your system will need to be able to accept a Webhook. If your system does not accept a Webhook directly, you can use a third-party tool like Zapier.com or make.com to pass the webhook and feed into your system. 

Click here to learn how to send your Webhook through Zapier. 

    • Related Articles

    • How to set up a JSON webhook integration between Salesforce and Franchise Ninja

      Salesforce can accept direct JSON webhooks. A JSON webhook allows external systems to send JSON data to your Salesforce org without requiring OAuth authentication. Below, you will find detailed information on how to set up the JSON webhook. ...

    • How to Test Your Webhook HTTP Postback

      Testing Webhooks with Webhook-Test.com Webhooks are essential for enabling systems to communicate by sending real-time data from one application to another. Testing a webhook before deploying it in a live environment is crucial to ensure proper ...

    • How do I create a Webhook to Zapier?

      When setting up your Webhook integration, you have the option to send via Zapier if your system does not take a direct Webhook. In the example below, we will walk through how to send information to a Google Sheet in real-time with our Webhook ...

    • Available Webhook Fields

      What fields are available when setting up a webhook? The webhook integration allows you to connect Franchise Ninja with other systems. When creating your webhook, the following fields are available for integration. These fields can also serve as ...

    • The Difference Between a Webhook and a Connector.

      Simple Integration with Minimal Information. Our connectors are perfect for easily building your email list. The connectors will automatically push your new contacts into the selected mail list. You will get a name, email address, and physical ...