What Is the JSON API Connector in ZazzyAgent?

ZazzyAgent can exchange customer information with external applications.

One of the integration options designed for this is the JSON API Connector.

It is useful when you want to take information collected by a ZazzyAgent flow and send it to another system as JSON.

What does the JSON API Connector do?

The connector sends structured JSON data to a URL you provide.

For example:

Customer
   ↓
ZazzyAgent User Input
   ↓
JSON API Connector
   ↓
Your Webhook
   ↓
Your Application

The receiving application can then process the information.

What is JSON?

JSON is a structured way of representing data.

For example:

{
  "name": "Rahul",
  "email": "rahul@example.com",
  "budget": "75000"
}

A receiving system can read these values programmatically.

When should you use the JSON API Connector?

Use it when an external system needs customer data from ZazzyAgent.

Examples:

• CRM integration

• Lead processing

• Internal applications

• Database workflows

• Custom backend automation

• External notification systems

• Zapier/automation workflows

The current connector documentation specifically describes sending User Input data to an external webhook URL as JSON. (botsailor.com)

JSON API Connector vs HTTP API

These are easy to confuse.

HTTP API

ZazzyAgent calls an external API.

ZazzyAgent
   ↓
External API

JSON API Connector

ZazzyAgent sends customer/event data to the configured endpoint.

ZazzyAgent
   ↓
Webhook / External System

The key question is:

Who is initiating the request?

Typical JSON API workflow

A common setup is:

User Input Flow
       ↓
Customer provides data
       ↓
JSON API Connector
       ↓
External webhook
       ↓
Your system processes data

Step 1: Create your User Input Flow

Build a flow that collects the information you need.

For example:

Name

Email

Phone

Requirement

Save those responses.

Step 2: Create your receiving endpoint

Your external application needs a URL that can receive the JSON request.

For testing, you can use a webhook inspection service or your own endpoint.

Step 3: Create the JSON API connection

Open the JSON API Connector in ZazzyAgent.

Create a connection.

Give it a clear name.

For example:

CRM Lead Submission

Step 4: Enter the webhook URL

Paste the URL where ZazzyAgent should send the JSON data.

Step 5: Select the trigger

Choose the relevant User Input Flow as the trigger.

This tells ZazzyAgent when to send the data.

Step 6: Choose the fields

Select the information you want to send.

For example:

• First Name

• Last Name

• Email

• Phone

• User Input fields

The current connector allows you to select system fields, custom/user-input data or both. (botsailor.com)

Step 7: Save the configuration

Save the connector after configuring it.

Step 8: Test the flow

Start your User Input flow.

Answer the questions.

Then inspect the receiving endpoint.

You should see the JSON request.

Example

Customer provides:

Name: Rahul

Email: rahul@example.com

Requirement: WhatsApp automation

The receiving system may get:

{
  "first_name": "Rahul",
  "email": "rahul@example.com",
  "requirement": "WhatsApp automation"
}

The exact payload depends on the fields you've selected and your ZazzyAgent configuration.

What can your external system do?

After receiving the data, your application can:

• Create a CRM lead

• Store a database record

• Send an internal notification

• Trigger another workflow

• Start an email process

• Create a task

ZazzyAgent doesn't need to do everything itself.

The connector lets another application take over after the data is collected.

Use JSON API with lead qualification

A lead agent can collect:

• Name

• Requirement

• Budget

• Timeline

Then the connector sends the information to your CRM.

Instagram / WhatsApp
       ↓
AI / Flow
       ↓
Lead Qualification
       ↓
User Input
       ↓
JSON API
       ↓
CRM

Use it with surveys

A survey can collect:

• Rating

• Feedback

• Comment

The connector sends those answers to your database or analytics system.

Use it with custom applications

This is especially useful if your business has software that isn't available as a native ZazzyAgent integration.

You can build a receiving endpoint and let ZazzyAgent send the data there.

What about authentication?

The current JSON API Connector documentation describes sending data to public or pre-authenticated endpoints through the connector. If your system requires custom authentication headers or tokens that the connector does not support directly, a secure backend relay is the safer architecture. (botsailor.com)

Don't expose private credentials inside customer-facing flow messages.

JSON API Connector vs Webhook Workflow

These features can sound similar.

A Webhook Workflow is typically used to receive data/event information from another system and then start an automation in ZazzyAgent.

A JSON API Connector is used to send structured ZazzyAgent/customer data outward to a configured endpoint.

Think:

Webhook Workflow = incoming data

JSON API Connector = outgoing data

JSON API vs Google Sheets

Use Google Sheets when a spreadsheet is the destination and suits the workflow.

Use JSON API when you need programmatic integration with another application.

Test before going live

Always send a test submission.

Verify:

• Request arrives

• JSON is valid

• Correct fields are included

• Values are correct

• External system processes them correctly

Keep the payload small

Only send information the receiving system needs.

There's no reason to send every available customer field if the receiving application only needs five.

Name integrations clearly

Good:

CRM – New Lead

Booking System – Appointment Request

Poor:

Test JSON

Clear names make maintenance much easier.

The simplest mental model

Remember:

Collect information
       ↓
Turn it into JSON
       ↓
Send it outward
       ↓
External system processes it

That's the main purpose of the JSON API Connector.