Help Desk
  • Getting Started
    • πŸ™ŒWelcome to Whapi.Cloud
    • πŸ’°Pricing
    • β˜•Partners
    • πŸš€Getting started
    • πŸ‘¨β€πŸ’»API Docs
      • Developer hubs
      • Swagger environment
      • Postman collection
  • Sending
    • Introduction
    • Send text message
      • Whatsapp API send message PHP
      • Whatsapp API send message Python
      • Whatsapp API send message Node JS
      • Whatsapp API send message Π‘#
      • Whatsapp API send message Java
      • API integration with VB6
      • Whatsapp API send message GO (Golang)
    • Send video, audio, image, document
    • Send Group message
    • Send post to WhatsApp Channel
    • Send message with Buttons
    • Send Emoji
    • Overview of other methods for sending
      • Send Voice message
      • Send contact (vCard)
      • Send message reactions
  • Receiving
    • Introduction
    • Webhooks
      • Our webhooks (Tracked events)
      • Where to Find the Webhook URL?
      • Set the webhook link to the channel
      • Detailed webhook settings
      • How to check the webhook?
      • Incoming webhooks format
        • Incoming message
        • Sent message
        • Chats
        • Groups
        • Account and device status
        • Other
          • Presences
          • Views of stories (statuses)
          • Story (status) from your contacts
          • Calls
      • Receive messages
        • Receive WhatsApp messages using PHP
        • Receive WhatsApp messages using Node js
        • Receive WhatsApp messages using Python
    • HTTP API
      • Retrieve a Specific User's Chat History
      • Get a full-size picture in the response
      • Get order items
      • Get a profile picture of a chat or user
    • File expiration period
  • Groups
    • Send Group message
      • Mentioning all participants in a WhatsApp group
    • Get list of group members
    • Add new member to Group
  • Channels
    • Send post to WhatsApp Channel
    • Get messages from Channels
    • Get votes from polls in the Channel
  • Communities
    • Introduction
    • Create a community
    • Add a member to a community
    • Send announcement
    • Get info on community participants
    • Add a group / Exclude a group from the community
  • Account
    • Setting "Auto Download"
    • Customizable Webhook Headers
    • How to find out the IP channel
    • How to Delete a Channel
    • Add Business Info to Invoice
  • Source code
    • WhatsApp ChatBot
      • WhatsApp Python Bot
      • WhatsApp PHP Bot
      • WhatsApp Node JS Bot
      • WhatsApp Java Bot
    • WhatsApp API Google Sheets
    • WhatsApp Phone Number Checker
    • Request Distributor (Balancer)
  • FAQ
    • Chat ID. What is it and how to get it?
    • Current status of Buttons on WhatsApp
    • How to send a paragraph (line break)
    • Inactive Links in WhatsApp Messages
    • WhatsApp Text Formatting
    • Checking if the number has Whatsapp
    • Specifics of sending messages to numbers of different countries
    • Why aren't participants being added to the group?
  • Does WhatsApp API Work with the Phone Turned Off?
  • Hints
    • Android Emulators
    • Virtual Numbers for WhatsApp
    • How to use polls as buttons?
    • How to check who blocked you in Whatsapp?
    • Setting up a WhatsApp proxy
  • Integrations
    • Make.com
      • Ready-Made Scenarios
        • WhatsApp & Whisper API: Voice-to-Text Integration
        • Automated WhatsApp Group Message Forwarding in Make.com
      • Request Scenario Setup
    • Pabbly Connect
    • Google Contacts
    • DialogFlow
    • n8n
  • Tools
    • WhatsApp Number Checker
    • Automatic warm-up module
    • WhatsApp Activity Safety Meter
    • Residential Proxies from Whapi.Cloud
  • Troubleshooting
    • Couldn't Link Device – WhatsApp QR Code or Pairing Code Fails
    • Channel status β€œSYNC_ERROR”
    • Not getting a READ status on webhook
    • 429 (Too Many Requests) - Soft Ban
    • β€œWaiting for this message. This may take a while” – WhatsApp Message Error
    • Missing push notifications after connecting to API
  • Blocking
    • How to not get Banned?
    • How to do mailings without the risk of being blocked?
    • If My Number Is Banned, Can It Be Restored?
    • Unlocking Your WhatsApp Number
    • Connecting a New WhatsApp Number After a Ban: Steps and Recommendations
    • Warming Up New Phone Numbers for WhatsApp API
  • Partner Documentation
    • Introduction
    • Partner Dashboard Overview
    • Partner Program Guidelines
      • Workflow: Step-by-Step
      • Billing for Partners
      • Allocating Days to Customer Channels: Best Practices & Guide
      • Interface for channel management
    • Partner Documentation
      • Channel creation
      • Changing channel mode
      • Channel extension
      • Channel deletion
      • Getting the list of channels
      • Notices of end of days on balance
Powered by GitBook
On this page
  • Setting Up a Webhook on a Hosting Platform
  • Popular Cloud Services
  • Firebase
  • AWS (Amazon Web Services)
  • Heroku
  • Local testing
  • How do I check if callbacks are being sent from a channel?

Was this helpful?

  1. Receiving
  2. Webhooks

Where to Find the Webhook URL?

How to set up a webhook URL to receive real-time data from our API

PreviousOur webhooks (Tracked events)NextSet the webhook link to the channel

Last updated 6 months ago

Was this helpful?

To set up a webhook URL, you'll need to configure a server endpoint that can handle incoming HTTP requests from our API. This allows your application to receive real-time data, such as message updates, directly from WhatsApp.

Setting Up a Webhook on a Hosting Platform

You can set up a webhook on any server that can handle HTTP requests

  1. Check the Platform’s Documentation: Most hosting services, even small ones, offer a way to handle HTTP requests. You should look for documentation or tutorials on how to set up a web application or endpoint on your hosting platform.

  2. Create the Webhook Script: As with any server, you need to create a script that can handle HTTP POST requests. This script will be responsible for processing and responding to incoming data from the webhook. We have written more about this in the articles here: Receive messages

  3. Deploying the script: Once the script is ready, it needs to be uploaded to the hosting platform. Depending on the platform, this could be uploading via FTP, using a version control system such as Git, or other deployment tools provided by the hosting service.

  4. Get a public URL: Once the script is running on the hosting platform, the platform should provide a public URL for the deployed endpoint. This URL is what you will use as the URL of the webhook.

  5. Test the webhook: Before using the webhook in production, it is worth testing it to make sure that it works correctly and that the platform handles requests correctly. We've written about how to do this here:


You can use popular cloud platforms to get a webhook link. Below, we provide instructions for setting up a webhook on three popular platforms β€” Firebase, AWS, and Heroku.

Popular Cloud Services

Firebase

Firebase offers Cloud Functions functionality, allowing you to run your bot without worrying about server infrastructure. In our opinion, this is the most optimal option.

  1. Create a project in ;

  2. Install Firebase CLI, following ;

  3. Initialize Firebase in your project directory with the command firebase init;

  4. Deploy your bot using the command firebase deploy --only functions.

AWS (Amazon Web Services)

AWS Lambda offers the ability to run code in response to triggers from other AWS services, making it a good choice for a bot.

  1. Create a new Lambda function through the AWS console, selecting API Gateway as the trigger;

  2. Upload your bot's code into the Lambda function;

  3. Configure the API Gateway to interact with your bot and the outside world.

Heroku

Heroku offers an easy-to-use platform for hosting applications, which can automatically deploy code from your Git repository.

  1. Install Heroku CLI and log in;

  2. Create a new Heroku app through the console or using the command heroku create;

  3. Link your Git repository to Heroku and perform deployment with the commands git push heroku master;

  4. Set the webhook URL provided by Heroku

Local testing

When developing a WhatsApp bot, you might want to test it locally before deploying it to a server.

The simplest way to do this is to use tools like Ngrok, which creates a secure tunnel to your localhost, allowing you to provide access to your local server from the internet.

How do I check if callbacks are being sent from a channel?

Especially for this purpose, we offer you a special endpoint that allows you to simulate any callback on any event. Thus, you can check if your link is available for our API, as well as see the format of the callback itself.

Register or log in to ;

Create an account on ;

For more information on how to configure and test Webhook locally, see the article:

AWS Management Console
Heroku
Firebase Console
the instructions
Test webhookWhapi Cloud - Whatsapp API for developers
Emulates a test callback to your link
Logo
How to test Webhook functionality?
How to test Webhook locally?