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
  • Our webhooks (Tracked events)
  • How do I configure my webhook?
  • Debug incoming webhooks
  • What request comes to Webhook?
  • Receive incoming webhooks
  • Our support

Was this helpful?

  1. Receiving

Webhooks

Webhook technology allows you to fulfill incoming notifications directly to your server

PreviousIntroductionNextOur webhooks (Tracked events)

Last updated 1 year ago

Was this helpful?

A webhook is an HTTP callback that sends data to your website or app when a certain event happens. They are typically used to update third-party services in real time. As we learned in the , a customized Webhook sends you notifications when certain events occur on your WhatsApp. These notifications will come to you automatically as soon as the event occurs.

The advantages of this technology are the fastest possible receipt of incoming notifications and high bandwidth, limited only by the speed of notification processing on your server side.

In this article, we will cover how to configure and test the webhook, what events it tracks, and what settings you might find useful.


In order to receive incoming webhooks, a public IP address / host is required to be accessible from the Internet. This way the Whapi.Cloud server will be able to make a call to your server at the specified address and deliver the incoming webhook.

Server configuration

  1. Whapi.Cloud does not accept webhooks that aren’t HTTPS;

  2. Your endpoint needs to accept a POST/PUT/PATCH/DELETE;

Our webhooks (Tracked events)

  • Messages: got new message / edit message / delete message;

  • Statuses: got message status;

  • Chats: got chat / chat update / chat remove;

  • Contacts: contact update;

  • Presences: got presences;

  • Groups: new group / participants update / group update;

  • Calls: got call events;

  • Labels: new label / remove label;

  • Users: connecting a session / disconnecting a session;

  • Channel: instance status changed / QR-code update;

  • Service: special notifications about Whapi integrations.

For a detailed description of all webhooks, see here: Our webhooks (Tracked events)


How do I configure my webhook?

You can configure incoming notifications either interactively or through the API. You will need an authorized channel to enable these settings.

On the channel page, you will need to find the "Settings" button in the top right corner. After an additional settings window appears, set a direct link to the webhook and enable the settings you need.

We have prepared instructions in a separate guide: Set the webhook link to the channel


Debug incoming webhooks

The service provides a unique address (URL), which must be set as the value of the link to webhook in the channel settings.

Detailed instructions and how to test locally are described in the manual: How to check the webhook?


What request comes to Webhook?

For each request there is a specific JSON body.

For a detailed description of the format of incoming notifications, see manual: Incoming webhooks format

Receive incoming webhooks

After receiving an incoming request to your server address, you will need to process the received hook.

You can find PHP / Python / NodeJS code examples for handling incoming webhooks here: Receive messages


Our support

Remember, if you have any questions or issues along the way, our support team is always available to help. We value every user and strive to ensure that your experience with our API is as smooth and efficient as possible.

To debug incoming notifications, you can use any free service on the Internet, such as the service.

You can write to the web chat widget on our main website, or in your personal account. Or write to us by e-mail:

webhook.site
introduction
care@whapi.cloud