BotPenguin Resource Centre
What's NewDashboard
  • 🏠Introduction
  • 📒BotPenguin Resource Centre
    • 🏃‍♂️How BotPenguin works?
      • Onboarding
      • Create new chatbot
        • Website Chatbot
        • Landing Page Chatbot
        • WhatsApp Chatbot
        • Instagram Chatbot
        • Facebook Chatbot
        • Telegram Chatbot
        • Microsoft Teams Bot
        • Make Your Live Chat Chatbot
      • Edit Your Chat Flow
        • Multiple flows(Redirect component)
        • Components In Chatflow
          • Request Information
          • Send Information
          • Trigger Actions
        • Email Validation
      • Pre-Built Chatbot Templates
      • Train Your AI Chatbot
        • Website
        • File Upload
        • Google Sheets
        • FAQs
        • Unanswered Questions
        • Other Sources
      • Install your Chatbot
        • Install your Website Chatbot
        • Install Website Chatbot on Custom Build Website
        • Install Website Bot on WordPress
        • Install Website Chatbot on Wix
        • Install Website Chatbot on Squarespace
        • Widget Installation
      • Automation
        • Widget
        • WhatsApp Template Setup
        • WhatsApp Catalog Setup
        • WhatsApp Flows (Forms) Setup
        • WhatsApp Broadcast Setup
        • WhatsApp Drip Campaigns Setup
        • Facebook Auto-Reply Feature
        • Instagram Auto-Replies
        • Instagram Automation
          • Instagram Broadcast
      • Bot Settings
        • Website Chatbot Settings
          • Design
            • Customize Landing Page Bot
          • General
          • Alerts
          • Triggers
          • User Access
          • Chat Window
            • Transfer Chat to WhatsApp Functionality
          • AI settings
            • Configuring Chatbot Scenarios
        • WhatApp Chatbot Settings
          • General
          • Triggers
          • Alerts
          • API Key
          • WhatsApp Profile
          • AI settings
            • Configuring Chatbot Scenarios
        • Telegram Chatbot Settings
          • General
          • Telegram Profile
          • AI settings
        • Instagram Chatbot Settings
          • General
          • AI settings
            • Configuring Chatbot Scenarios
        • Facebook Chatbot Settings
          • General
          • AI settings
            • Configuring Chatbot Scenarios
        • Chatbot Persona
        • Creating Custom Instructions
        • How to configure and use AI Assistants
      • 3rd Party Apps Integrations
        • ChatGPT
        • BotPenguin Integrations
          • Integrate BotPenguin with Acuity Scheduling
          • Integrate BotPenguin with Microsoft Teams
          • Integrate BotPenguin with WooCommerce
          • Integrate BotPenguin with Autopilot
          • Integrate BotPenguin with Firmao CRM
          • Integrate BotPenguin with Capsule CRM
          • Integrate BotPenguin with Facebook Pixels
          • Integrate BotPenguin with Elevio CRM
          • Integrate BotPenguin with Close CRM
          • Integrate BotPenguin with CalendarHero CRM
          • Integrate BotPenguin with Extraaedge CRM
          • Integrate BotPenguin with Infobip CRM
          • Integrate BotPenguin with Google Sheets
          • Integrate BotPenguin with Google Calendar
          • Integrate BotPenguin with Google Task
          • Integrate BotPenguin with Google Gemini
          • Integrate BotPenguin with HelpShift CRM
          • Integrate BotPenguin with Zendesk CRM
          • Integrate BotPenguin with LeadSquared CRM
          • Integrate BotPenguin with Zoho Desk
          • Integrate BotPenguin with SupportBee CRM
          • Integrate BotPenguin with Wealthbox CRM
          • Integrate BotPenguin with Brevo (formally SendInBlue)
          • Integrate BotPenguin with Apptivo CRM
          • Integrate BotPenguin with Freshdesk CRM
          • Integrate BotPenguin with Help Desk CRM
          • Integrate BotPenguin with Helpcrunch CRM
          • Integrate BotPenguin with Jira CRM
          • Integrate BotPenguin with KarmaCRM
          • Integrate BotPenguin with LiveAgent CRM
          • Integrate BotPenguin with NetHunt CRM
          • Integrate BotPenguin with Plivo CRM
          • Integrate BotPenguin with Recurly CRM
          • Integrate BotPenguin with Shipway CRM
          • Integrate BotPenguin with TeamGate CRM
          • Integrate BotPenguin with Zoho Projects
          • Integrate BotPenguin with Zoho CRM
          • Integrate BotPenguin with Google Drive
          • Integrate BotPenguin with Agile CRM
          • Integrate BotPenguin with Pipedrive
          • Integrate BotPenguin with Drip CRM
          • Integrate BotPenguin with GetResponse
          • Integrate BotPenguin with Groove
          • Integrate BotPenguin with Helpdocs
          • Integrate BotPenguin with Bitrix24
          • Integrate BotPenguin with Freshworks CRM
          • Integrate BotPenguin with Insightly CRM
          • Integrate BotPenguin with Nimble CRM
          • Integrate BotPenguin with Nutshell CRM:-
          • Integrate BotPenguin with OntraPort CRM
          • Integrate BotPenguin with HubSpot
          • Integrate BotPenguin with WebHoper
          • Integrate BotPenguin with EngageBay
          • Integrate BotPenguin with FrontApp
          • Integrate BotPenguin with Copper CRM
          • Integrate BotPenguin with Salesflare
          • Integrate BotPenguin with No CRM
          • Integrate BotPenguin with Helprace
          • Integrate BotPenguin with Flowlu
          • Integrate BotPenguin with Pipeline
          • Integrate BotPenguin with Zingtree
          • Integrate BotPenguin with Salesforce CRM:-
          • Integrate BotPenguin with Chakra CRM:-
          • Integrate BotPenguin with SimplyBook:-
          • Integrate BotPenguin with Gitbook
          • Integrate BotPenguin with GoHigh Level
          • Integrate BotPenguin with Voxloud
          • Integrate BotPenguin with ViaSocket
          • Integrate BotPenguin with Twilio
          • Integrate BotPenguin with Shopify
          • Integrate BotPenguin with Razorpay
          • Integrate BotPenguin with Pabbly
          • Integrate BotPenguin with Outlook
          • Integrate BotPenguin with OnPipeline
          • Integrate BotPenguin with Notion
          • Integrate BotPenguin with MoEngage
          • Integrate BotPenguin with Kylas CRM
          • Integrate BotPenguin with Google Analytics
          • Integrate BotPenguin with FirstPromoter
          • Integrate Botpenguin with Google Contacts
          • Integrate Botpenguin with Zoho CRM
          • Integrate BotPenguin with Zapier
          • Integrate BotPenguin with Make.com
      • Inbox
        • Chats window
        • Orders
        • Contacts
        • Groups
        • Real-Time Customer Interaction
        • Importing WhatsApp Contacts
        • Creating Segments
        • Using Tags
      • Analytics
      • Teams
        • Departments
        • Business hours
        • Team
        • Role
        • Using Teams in Chatflow
      • Settings
        • Custom Attribute
        • Tags
        • Custom Status
        • Quick Replies
        • Custom Tabs
      • My Account
        • Account
        • Password
      • Subscription & Plans (Legacy Version)
      • Subscription & Plans (Latest Version)
    • ❓Frequently asked questions (FAQs)
      • Onboarding FAQs
      • Edit your chat flow
      • Bot Installation FAQs
      • Inbox FAQs
      • Profile, Team & Notifications FAQs
      • Analytics FAQs
      • Chat Flow FAQs
      • Bot Settings FAQs
      • WhatsApp FAQs
      • Subscription FAQs
      • Product Update FAQs
      • ChatGPT FAQs
    • 🛠️Common Errors & Troubleshooting
  • 📖Platform Guidelines & Training
    • 👩‍💻WhatsApp Cloud API by Meta
      • ⚙️Setting Up Your Facebook Business Manager
      • 💰Meta Conversation Pricing for WhatsApp Cloud API
      • 👧Update WhatsApp Bot Profile
      • ✅Getting a Blue Tick(previously Green Tick) on WhatsApp
    • 🔑WhatsApp Bot Creation with Manual Onboarding
      • ✅Prerequisites for WhatsApp Bots
      • 🔤Create a Meta App
      • ✔️Register & Verify your WhatsApp Number
      • 🔗Subscribe WA webhook with BotPenguin
      • 💳Update WA account Payment Method
      • 🦸‍♀️Assign System User to WhatsApp Account
      • 📃Getting all the necessary details from Meta Developer Dashboard
    • ⚙️WhatsApp Bot Creation with Automated onboarding
    • 🐧Migration Of Whatsapp Account from other platforms to BotPenguin.
    • ♻️Reconnect Whatsapp Bot
    • 🔏Recovering Your Restricted Meta Account
    • 💡Must know-how of BotPenguin
      • 🔤Manage & Use Custom Attributes
      • 🖥️Call external APIs in your chat flows
      • 👨‍💼Manging team roles & Users
      • 🪄Unlock BotPenguin AI
      • 🕵️‍♂️Support Agent guide
      • 📨Send WhatsApp notifications using the BotPenguin APIs
      • Chatbot User Authentication
  • ⚡Platform Updates & Info
    • 🔥What's New
    • 🐞Report a bug!
    • 🗒️Feature Requests
    • 🐧BotPenguin Roadmap
    • 🤝Connect With Us
  • 🛠️API References
    • 📄Contacts & Chats APIs
      • Get All Contacts
      • Getting Groups/Segments
      • Add WhatsApp Contact
      • Delete WhatsApp Contact
      • Website Contacts & Meta Data
    • 📄WhatsApp Cloud API
      • GET Templates List
      • POST WhatsApp Template Message
      • POST Send Message API
  • 🤝Partner Documentation
    • 🐧BotPenguin Partner Onboarding
      • Signup as a BotPenguin Partner
      • Setup your Pricing Plans
      • Connect to your Domain
      • Setup 3rd Party Integrations
        • Setup AWS SES Account
        • Setup Google reCAPTCHA
        • Setup ChatGPT Account
        • Setup Zoho Integrations
        • Setup Google OAuth App
        • Setup RazorPay Account
        • Setup Stripe Account
        • Setup Facebook App for WhatsApp & Facebook Bots
          • Create Facebook Login for Business Configuration
          • Meta System User Token
      • Setup your pricing plans (Legacy Version)
      • Setup your Pricing Plans (Latest Version)
    • 🙋‍♂️Partner FAQs
      • Onboarding
      • Affiliate Partner
      • Implementation Partner
      • Whitelabel Partner
      • WhatsApp Whitelabel Partner
      • Add-ons FAQs
      • Subscription FAQs
      • LTD FAQs
    • 📔Partner API References
      • Setting up environment
      • Get Customer
      • Create Customer
      • Update Customer
      • Delete Customer
      • Get Customer API Token
      • Get Team Members (Custom Users)
      • Get Custom User (Team Member) Token
      • Embedding the BotPenguin Inbox in 3rd Party Apps
Powered by GitBook
On this page
  • What is an external API?
  • Types of APIs
  • Workflows of using APIs in ChatFlow
  • Using APIs in the Chatflows

Was this helpful?

  1. Platform Guidelines & Training
  2. Must know-how of BotPenguin

Call external APIs in your chat flows

This page contains information about how you can call external APIs in your chat flows.

PreviousManage & Use Custom AttributesNextManging team roles & Users

Last updated 1 year ago

Was this helpful?

Currently, the API chat component is only being supported for WhatsApp Bot, Coming soon for the rest of the channels.

What is an external API?

An external API (Application Programming Interface) refers to a set of rules and protocols that allow one software application to interact and communicate with another external software system, service, or platform. It enables different software programs to access and exchange data and functionalities seamlessly, even if they are developed by different organizations or run on different servers.

Types of APIs

There are several types of APIs, each serving specific purposes and use cases.

We are currently supporting the JSON-based RESTful APIs with the API key, JWT Token, or public APIs

Workflows of using APIs in ChatFlow

Here is the flow for using the APIs in the Chatflows

Using APIs in the Chatflows

To seamlessly integrate APIs into your chat flows in BotPenguin, follow these steps:

Step 1: Access the BotPenguin Dashboard

  • Log in to your BotPenguin account and access the dashboard.

Step 2: Navigate to the Developers Section

  • From the side navigation bar, locate and click on "More."

  • Within the "More" section, select "Developers."

Step 3: Prepare Custom Attributes

  • Before proceeding, ensure you have added all the necessary custom attributes that you'll require for the API interactions. Custom attributes will help capture and manage data. Refer to the doc before creating and managing the custom attributes

Step 4: Add a New API

  • In the "Developers" section, find "Your APIs" and click on "Add API" at the top right corner.

Step 5: Configure Your API

  • Under "Configure APIs," set the following details. The structure is similar to Postman for testing APIs:

    • API Name: This is the display name for the API, used for better readability within BotPenguin.

    • API Method: Specify the HTTP method (e.g., GET, POST, PUT).

    • Enter API URL: Provide the URL for the API you intend to call.

    • Query Parameters: Add any required query parameters.

    • Headers: Include necessary headers for the API.

    • Body: Define the request body if needed.

Note: If you want to insert custom variables within the API, use "/" as a placeholder. However, for the initial setup, you'll need to enter the actual values to test the API and save the response structure.

Step 6: Test the API

  • Proceed to "Manage API Response" and click on "Test" the API with actual values. This will help BotPenguin understand the API response structure.

Step 7: Map API Response to Custom Attributes

  • In the "Manage API Response" tab, you can map the API response variables to your BotPenguin custom attributes.

Step 8: Replace Actual Values

  • If required, replace the actual values in your API configuration with the custom attributes that you've mapped.

Step 9: Access Your Chatflow

  • Navigate to your Bot's chatflow by clicking on "Edit your Chatflow" under the "Bots" section.

Step 10: Select the "API" Chat Component

  • In the list of chat components, choose the "API" chat component.

Step 11: Call the API

  • In the right panel, call the API by selecting the API you've configured earlier by its name.

Step 12: Map the next Questions

  • Map the next question based on your API's response code (e.g., 200, 300, etc.). If the API response code doesn't match any predefined values, it will trigger the response mapped to "others."

And you're done! Your API is ready to enhance your chatbot's functionality and provide dynamic interactions based on API responses.

📖
💡
🖥️
🔤Manage & Use Custom Attributes
Workflows of using APIs in ChatFlow
Drawing