Configuring JSON WebHooks

This article describes how to set up and transmit data using JSON webhooks within the FORTH system. It was developed for FORTH CRM administrators and system integrators who need to configure custom JSON webhooks for automated data transmission to external endpoints. For information on other WebHook configurations, see our Help Center article Configuring WebHooks.

The article is organized into the following sections:

• Overview
• Prerequisites
• How to Access
• How it Works
• Troubleshooting / FAQ
• Assistance

Overview

JSON (JavaScript Object Notation) webhooks transmit contact data from the FORTH CRM to external receiving systems in a standardized key-value format. The JSON file format uses human-readable text to transmit data objects consisting of key-value pairs and array data types. It is easy for machines to parse and generate, and for humans to read and write.

JSON is built on two structures:

• Object - A collection of key/value pairs
• Array - An ordered list of values

JSON is a text format that is completely independent but uses conventions that are familiar to programmers of the C family of languages. (ex. C++, JavaScript, Python, etc.)

To learn more about JSON, click -->: https://www.w3schools.com/whatis/whatis_json.asp

Setting up webhooks automates data delivery, eliminating manual data entry and reducing transfer errors. This configuration ensures external partners and receiving applications receive immediate, structured contact information.

Prerequisites

Standard administrator access to the FORTH CRM with permissions to configure webhooks and custom fields.

How to Access

1. Log in to the FORTH CRM.
2. Click the Contacts tab on the main navigation bar.
3. Select Webhooks from the secondary navigation bar.
   

How it Works

1. The WebHooks page will look like the image below.
   
2. Navigate to the WebHook URL* field and enter the destination JSON endpoint URL provided by your receiving party.
   
3. Locate the Headers section and enter the required header keys and values specified in your posting instructions from the receiving party (for example, Header = contentType and Value = application/json).
   • The Content-Type entity header indicates the media type of the resource. In responses, it indicates the content type of the returned content.
     
     Each post expects different items to be passed in the header. You can have as many headers as needed/required by the receiving party.
4. Click Save WebHook to save your endpoint and header information.
5. Go to the Request Type section and select RAW JSON to enable the JSON body editor.
   

6. In the JSON Body field, construct your JSON payload. Use double quotes for key names, colons, and field tags in double quotes for values (for example, "first_name": "{FIRSTNAME}"). Separate each key-value row with a comma and wrap the list in curly brackets {}.

   {
   “first_name” : “{FIRSTNAME}”,
   “last_name” : “{LASTNAME}”
   }

7. Use of Multiple Fields - To add multiple fields to be passed to ONE field on the receivers' end, you can add containers within the main JSON container. For example, if you want the fields of {ADDRESS}, {ADDRESS2} {CITY} {STATE} and {ZIP} to all be passed to ONE address field on the receiver's end, set up the JSON container like the one below. This will tell the post to add those fields together to one field instead of 5 individual fields.

{
    "first_name": "{FIRSTNAME}",
    "last_name": "{LASTNAME}",
    "address": {
        "street": "{ADDRESS}",
        "street2": "{ADDRESS2}",
        "city": "{CITY}",
        "state": "{STATE}",
        "zip": "{ZIP}"
    }
}

9. Add the required fields stated in the posting instructions to the JSON Body in the format above. 
   
10. If needed, click Format JSON at the bottom of the JSON Body field to clean up and structure your code automatically.
11. Click SAVE WEBHOOK to finish your setup.
12. Double-check the posting instructions to ensure you correctly set up the headers and JSON body.  You can then test the WebHook on a test contact. If everything is set up correctly, you should get a “Success” result under WebHook Results on the right-hand side of the WebHook page.

[INSERT SCREENSHOT: WebHook Results section displaying a successful post response.]

Troubleshooting / FAQ

• Why did my webhook fail with a payload error? Verify that every line in the JSON Body ends with a comma, except the last line before a closing bracket. Click Format JSON to detect syntax errors.
• Why is the receiving server rejecting the transmission? Check your posting instructions to ensure all required items exist in the Headers section, such as contentType = application/json.
• How do I test if my webhook sends correct data? Run a test using a mock contact record and view the output status in the WebHook Results pane.

Assistance

For further assistance, reach out to support@setforth.com.

2. SEO Keywords:

• JSON webhooks
• FORTH CRM webhook configuration
• Raw JSON post
• Webhook headers setup
• Endpoint integration CRM