JSON API Connector in BotSailor

📘 Introduction

 

JSON API connector sends JSON data to any of your provided external URLs. Once any specific event mentioned below is triggered, the system will send json data to your provided webhook URL & it will wait for 10 seconds to get a response. If the system does not get a response in 10 seconds, it will send another post request to your webhook. You can then process your data as you want. This feature can be used to connect our system with any third party app like Zapier or your own custom app.

In this guide, you'll learn how to:

  • Build a user input flow
  • Connect it with a webhook URL
  • Select the data fields to send
  • View the result in real-time

 

🧭 Step-by-Step Guide

 

🔹 Step 1: Create a User Input Flow

 

 

  1. In your Bot Flow, set a trigger keyword (e.g., json) to start the sequence.
  2. Add a User Input Flow block and give it a title.
  3. Add your first question (e.g., “What is your name?”), set reply type to Text, and save it to a Custom Field.
  4. Add additional questions like:
  • Email (save to system field: Email)
  • Phone Number (save to system field: Phone)
  1. Finish with a Thank You message block.

 

🔹 Step 2: Get a Webhook URL

 

 

  1. Visit Webhook.site
  2. Copy the unique URL provided — this is where BotSailor will send data.

🔹 Step 3: Navigate to JSON API Connector

 

 

  1. Go to JSON API Connector from the left-hand menu.
  2. Hit the Create button on the top right.

 

🔹 Step 4: Configure the Connector

 

 

  1. Connection Name: Name it (e.g., json check)
  2. Webhook URL: Paste the copied Webhook.site URL
  3. Select User Input Flow as the trigger type.
  4. Choose the Flow Campaign you created earlier (e.g., json test)
  5. Select the fields you want to send:
  • First Name
  • Last Name
  • Email
  • Phone Number
  • User Input Data
  1. Click Update to save.

 

🔹 Step 5: Test the Flow

 

 

 

  1. Trigger the flow in Messenger using your keyword (e.g., json)
  2. Answer the questions one by one.
  3. Confirm that the data is being sent to your webhook.

 

✅ Use Cases

 

  • 🔄 CRM Integration: Send lead data to HubSpot, Zoho, or Salesforce.
  • 🛍️ Order Collection: Pass product selection and contact info to an e-commerce backend.
  • 📧 Email Signups: Automatically sync subscribers with mailing tools.
  • 📊 Survey or Feedback Forms: Log responses for analysis or review.
  • 🚀 Custom Workflows: Trigger backend logic like alerts, database inserts, or task creations.

 

FAQ

 

Can I send data to any API?
Yes, as long as the endpoint supports JSON POST requests and CORS policies don’t block it.

Is authentication supported?
Currently, only public or pre-authenticated endpoints are supported via this interface. For headers or tokens, custom backend relay is recommended.

Can I send custom fields only?
You can choose what to send — system fields, custom fields, or both.

Can I test without a real server?
Yes! That’s what Webhook.site is used for — real-time testing before going live.

 

🏁 Conclusion

 

The JSON API Connector in BotSailor is a powerful tool to bridge chatbot interactions with external systems. Whether you’re collecting leads, syncing CRM data, or running webhook-triggered actions, this connector ensures your user input doesn’t stay locked in — it flows to where your business needs it most.

Powered by BotSailor.