JSON Post Guide
The JSON Post Lead Provider type allows you to send lead data to ampEducator using a JSON payload over an HTTP POST request. This is ideal if you are integrating with systems or applications that can send structured JSON data — such as custom applications, server-to-server integrations, or modern form builders. Once configured, incoming JSON posts will automatically create new Prospects in ampEducator.
- Go to Prospects / Lead Providers.
- Click the green Add Lead Provider button.
Set the Provider Type to JSON Post.
- Enter a Provider Name that clearly identifies the source (e.g., Open House App JSON).
- A Unique ID will be automatically generated. You can edit it if you wish, but once saved, it cannot be changed.
- (Optional) Add a Description.
- Click Add to continue.
You will then be taken to the profile page to configure the details.
After you add the JSON Post Lead Provider, you'll be taken to the Details page. Here, you’ll set up how incoming lead data is processed and routed.
At the top of the page, you’ll see important notes about how JSON Post works:
- JSON Post processes HTTP POSTs containing a JSON payload to create new Prospects in ampEducator.
- You must post your data to the Lead Provider URL provided.
- ampEducator will respond with a JSON object that includes:
- success – Whether the prospect was successfully added.
- messages – Any warnings or errors.
- log – The processing log details.
- query – A map of parsed data from the request.
- prospect – The created ProspectObject if successful.
- Restrict to IPs is available if you want to limit incoming posts to certain trusted IP addresses.
- JSON in Parameter (new): By default, ampEducator expects the JSON payload in the body of the POST request. If you select JSON in Parameter, ampEducator will instead look for the JSON data inside a specific query parameter.
Below the instructions, you’ll configure lead handling:
- Provider Type: Set to JSON Post (locked).
- Provider Name and Description: Editable if needed.
- Default Location: Assign all incoming leads to a location.
- Default Agent: (Optional) Pre-assign an agent if desired.
- Adm Advisor Assign: Choose Round Robin or Fixed advisor assignment.
- Default Country: Set a country if your JSON payload does not always include it.
Notifications:
- Email Adm Advisor / SMS Adm Advisor: Enable to notify the assigned advisor when a new Prospect arrives.
- Add Adm Advisor Event: Automatically create a follow-up event.
- Event Title: Customize the event label (e.g., Follow up with JSON lead).
- Email Notifications To / SMS Notifications To: Add others to receive alerts about new leads if needed.
There are two optional settings available to help control who can submit leads and how incoming JSON data is handled:
- Restrict to IPs: Add one or more IP addresses if you want to restrict submissions to trusted sources only. When used, only requests coming from the listed IPs will be accepted. If left blank, submissions from any IP will be allowed.
- JSON in Parameter: By default, ampEducator expects the JSON data to be posted in the body of the request. If your system sends the JSON as part of a query parameter instead, check this box. When selected, ampEducator will extract the JSON from the specified parameter instead of the body.
In most cases, Restrict to IPs is optional and JSON in Parameter should remain unchecked unless your system requires it.
Once your lead provider is set up, continue with configuring Actions, Field Mapping & Submissions. These tabs work very similarly across all lead provider types and allow you to automate follow-ups, map incoming fields, and review submissions.