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
      • Developer
        • 3rd Party Apps API
        • API Access Token
        • Webhooks
      • 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 are Webhooks?
  • Benefits of Using Webhooks in BotPenguin
  • How to use Webhooks on BotPenguin:
  • WhatsApp Webhook's
  • Instagram Webhook
  • Account Level Webhooks
  • FAQ's

Was this helpful?

  1. BotPenguin Resource Centre
  2. How BotPenguin works?
  3. Developer

Webhooks

This is a description of the webhooks section under the "Developer" tab in BotPenguin.

PreviousAPI Access TokenNextSettings

Last updated 1 day ago

Was this helpful?

What are Webhooks?

A webhook is a way for one app to automatically send data to another app when something happens. Instead of checking for updates all the time, the receiving app gives a special URL, and the sending app sends information to that URL as soon as the event occurs. This helps automate tasks, keep data updated in real-time, and connect different systems without manual work.


Benefits of Using Webhooks in BotPenguin

The following are the benefits of using webhooks on BotPenguin:

  1. Receive instant alerts on message failures, subscription expiries, and account issues.

  2. Trigger automated workflows based on real-time message and account events.

  3. Monitor platform activity with actionable insights on usage and performance.

  4. Integrate seamlessly with CRMs, marketing tools, and internal systems.


How to use Webhooks on BotPenguin:

  1. Log into your BotPenguin account, and then go Developer section under the More section.

  2. Click on the third tab to access the "Webhooks" section.

  1. Here, the user has the options to configure webhooks for 3 types, WhatsApp, Instagram and Account Level.

  2. Click on a card(WhatsApp, Instagram or Account Level) to configure the section.

  3. Click on "Subscribe Webhooks".

  1. A small popup window will open up. Enter your Webhook Endpoint, and verification key. Then, select the bots that you want the webhooks to be triggered for.

  1. Once selected, the webhooks will be configured. Now, we can go into the specifics of each and select the ones to turn on.


WhatsApp Webhook's

  1. There are many webhooks that have been created for WhatsApp. Some of them are as follows:

    Failed Message

    Tells when a message could not be delivered

    Account Alerts

    Tells when your account does not meet our notability requirements. You can edit the display name and submit another request after 30 days.

    Account Review Update

    Tells when account review request gets approved.

    Account Update

    Update on the business verification of the WhatsApp account.

    Business Capability Update

    Updates on the max daily limits per day

    Business Status Update

    Updates the status of the business

    Template Quality Update

    Updates on the template quality.

    Template Status Update

    Tells of the approval status of the template.

    Messages

    Tells of the messages that are recieved.

    Phone Number Name Update

    Updates you when the name related to a phone number is updated

    Phone Number Quality Update

    Tells of the plan quality of a new user.

    Security

    Tells information regarding the security of the PIN's.

    Template Category Update

    Updates the template category.

  1. To edit any webhook, click on the "Edit Webhook Subscription" button.

  2. To disconnect the webhook, turn off the status of the webhook. To disconnect all the webhooks status, click on the "Unsubscribe Webhooks" button and confirm the unhook process.


Instagram Webhook

  1. Instagram webhooks work similar in manner to WhatsApp Webhooks.

  2. To edit any webhook subscripton, click on the "Edit Webhook Subscription" button.

  3. To disconnect the webhook, turn off the status of the webhook. To disconnect all the webhooks status, click on the "Unsubscribe Webhooks" button and confirm the unhook process.


Account Level Webhooks

Webhook Name
Use Case

Message limit exhausted

Notifies the customer when their available message quota has been fully utilized. Customers can customize this notification to trigger when a certain percentage of their plan has been exhausted.

Conversation limit exhausted

Alerts the customer when their WhatsApp conversation limit is reached.

Plan expired

Sends a notification when the customer's subscription plan has expired.

Account freeze

Notifies the customer when their account is temporarily frozen due to non-payment or policy violations.


FAQ's

These are the commonly asked questions regarding Webhooks:

What are webhooks in BotPenguin?

Webhooks are automated callbacks that notify your system in real-time when specific events occur on BotPenguin, such as message delivery failures or subscription changes.

Which platforms do BotPenguin webhooks support?

Webhooks are supported for WhatsApp, Instagram, and application-level events within the BotPenguin ecosystem.

What kind of events can trigger a webhook?

Events include failed message delivery, auto-reply execution, message limit exhaustion, conversation usage updates, subscription expiry, and account freezes.

Are webhooks real-time?

Yes. BotPenguin webhooks are designed to send event notifications immediately as they occur.

What format does the webhook payload use?

Webhook payloads are sent in JSON format, containing structured data about the triggered event.

How can I test if my webhook is working?

BotPenguin provides testing options within the webhook configuration section, allowing you to simulate event triggers and validate your endpoint setup.

What should I do if my webhook endpoint fails?

Ensure your endpoint URL is active and accessible. BotPenguin may retry failed deliveries, but persistent failures will require you to debug and update your configuration.


If everything is correct and you are still unable to move forward, write to us at . We will respond back within 48 business hours.

📒
🏃‍♂️
support@botpenguin.com