Using External APIs in BotSailor: Full Guide to HTTP API Integration & Flow Builder Automation

Integrating third-party services with your chatbot is no longer just a technical luxury, it’s a marketing necessity. With BotSailor's built-in HTTP API Integration and Flow Builder support, you can connect your WhatsApp and Messenger bots with CRMs, email tools like Brevo, Google Sheets, e-commerce platforms, and more.

This documentation will walk you through:

• What HTTP API integration is
• How to configure external APIs in BotSailor
• How to trigger API calls inside a chatbot flow
• Practical examples with Brevo
• Tips and FAQs to ensure smooth automation

What is HTTP API Integration in BotSailor?

HTTP API Integration allows BotSailor to communicate with external systems through RESTful API calls. You can:

• Send data (POST)
• Retrieve data (GET)
• Update or delete data (PUT, DELETE)

Supported Use Cases:

• Sync leads to Brevo, Mailchimp, or HubSpot
• Send order data to spreadsheets
• Push chatbot responses to external workflows
• Enrich subscriber profiles with fetched data

Whether you're building a lead magnet, syncing e-commerce events, or triggering actions in CRMs, BotSailor’s HTTP API makes it possible, without writing backend code.

Why Use HTTP API Integration?

• ✅ No-code setup — connect APIs without writing any code.
• ✅ Real-time data sync — pass chatbot data instantly to CRMs or databases.
• ✅ Multi-platform support — integrate with platforms like Brevo, Google Sheets, or Zapier.
• ✅ Two-way sync — fetch data from an API and update your subscriber fields.

Part 1: How to Connect an External API in BotSailor

Follow these steps to set up an external HTTP API using Brevo as an example.

Step 1: Access HTTP API Settings

• Go to Integrations → HTTP API
• Choose a platform, e.g., WhatsApp HTTP API

Step 2: Click “Create” to Add a New API

Step 3: Copy a Test Subscriber ID

• Go to WhatsApp → Subscriber Manager
• Copy an existing subscriber ID for testing

Step 4: Generate API Key from Brevo

• Log in to Brevo
• Go to SMTP & API → API Keys → Generate a New Key

Step 5: Fill API Connection Details in BotSailor

• Name: Brevo Contact Add
• Method: POST
• URL: https://api.brevo.com/v3/contacts
• Test Subscriber ID: paste your copied ID

Header Data:

Step 6: Set Request Body (JSON) & Verify

{

  "email": "#LEAD_USER_EMAIL#",

  "attributes": {

    "FIRSTNAME": "#LEAD_USER_FIRST_NAME#"

  },

  "listIds": [1],

  "updateEnabled": true

}

Use dynamic variables such as:

• #LEAD_USER_EMAIL#
• #LEAD_USER_FIRST_NAME#
• #LEAD_USER_CHAT_ID#

Click Verify Connection to test.

Step 7: Save the API

Once verified, click Save API — ready to use in flows or broadcasts.

Part 2: Use HTTP API in Flow Builder (Automation)

After connecting the API, you can use it in chatbot flows. Here's how to trigger an external API from a WhatsApp conversation.

Step 1: Open Flow Builder

• Go to WhatsApp → Bot Manager
• Choose your bot and go to Bot Reply → Change Settings
• Click Create to start a new flow

Step 2: Add Input Collection

• Use User Input Flow to ask for an email address
• Set input type as Email

Step 3: Add HTTP API Block

• Drag the HTTP API block after input
• Select your saved API (e.g., “Brevo Contact Add”)
• Add a confirmation message block

Step 4: Test the Flow

• Send the keyword (e.g., sendbrevo) via WhatsApp
• Submit an email address
• BotSailor will respond and trigger the external API

Step 5: Confirm External Submission

• Check your external system (e.g., Brevo) for the new contact

Tips for Smooth API Integration

• Always test with real subscriber data before using in campaigns
• Double-check the API endpoint and headers
• Use clear names for your API actions to manage them easily
• Monitor API logs for errors
• Secure your API keys, don’t share them in public templates

Frequently Asked Questions (FAQs)

Can I use methods other than POST?
Yes. BotSailor supports GET, POST, PUT, and DELETE HTTP methods.

Can I update subscriber fields based on the response?
Absolutely. Use Response Mapping to sync returned data into BotSailor’s subscriber fields.

Is my API key stored securely?
Yes. API keys are encrypted and only shown once during setup.

Can I trigger the API after an event like order completion?
Yes. You can call APIs from form submits, catalog purchases, button clicks, and more.

What if the API call fails?
BotSailor will show the error during verification. It won’t save the integration until it passes.

Does this work for Messenger too?
Yes, the same Flow Builder can be used for both WhatsApp and Messenger bots.

Can I connect to Google Sheets or other platforms?
Yes. Any platform that supports HTTP requests can be integrated.