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
  • Mode setting
  • Webhook Events and Update Types (POST / PUT / PATCH / DELETE)
  • Persistent webhook setting (ex Persist)
  • Auto Download setting

Was this helpful?

  1. Receiving
  2. Webhooks

Detailed webhook settings

Webhooks Mode / Request Method / Persist webhook / Auto Download

PreviousSet the webhook link to the channelNextHow to check the webhook?

Last updated 26 days ago

Was this helpful?

There are a number of settings that affect the amount of data sent by the server, these settings can be changed in the interface or through the API.

Click 'Settings' to access more detailed webhook settings.

Here's a transcript of the hook's advanced settings:

Mode setting

Request method for sending hook

  • Body: All information about the webhook event is passed in the body of the request. If you select Body mode, event information such as event type, object ID, time and date will be specified in the body of the HTTP request. This is the standard and direct way to get data from webhooks.

  • Path: The URL of the webhook is updated depending on the event. In Path mode, the URL of your webhook will change depending on the type of event. For example, if the event is called 'message.post', the URL 'https://example.com' will change to 'https://example.com/message/post'. This mode is useful for separating the processing of different types of events into different URLs.

  • Method: The event method is used as the HTTP method of the request. In Method mode, an event method such as 'message.patch' defines the HTTP method of the request. So, 'POST https://example.com' will turn into 'PATCH https://example.com/message'. This mode is good for advanced event handling when you want to use specific HTTP methods for different actions.

Webhook Events and Update Types (POST / PUT / PATCH / DELETE)

In your webhook settings, you can choose which event types your server should receive. These event types describe what happened to an object (like a message or group), but they are not the HTTP request methods. All events are sent via POST requests if the Body mode is enabled.

Here’s what each event type means in the context of our API:


POST

Indicates the creation of a new object. Example: A new message arrives on WhatsApp β€” you'll receive a POST messages event.


DELETE

Signals that an object has been deleted. Example: A user deletes a message β€” you'll receive a DELETE messages event.


PUT

Means a full update of an object. Example: A message status changes from sent to delivered β€” you’ll receive a PUT statuses event. Also applies when a group participant list is updated entirely (e.g., multiple participants are added at once, and the full list is refreshed).


PATCH

Represents a partial update β€” only specific fields in the object have changed. Example: A new message appears in a chat, but other chat properties (like name or image) remain the same β€” you’ll receive a PATCH chats event with a changes array showing only the modified fields.


If you're unsure which events or update types are relevant to your use case, feel free to contact our support team β€” we're happy to help.


Persistent webhook setting (ex Persist)

You will need three parameters:

  • callback_backoff_delay_ms: Backoff delay for a failed callback in milliseconds This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a HTTPS 200 OK response. The backoff delay is capped by the max_callback_backoff_delay_ms setting.

  • max_callback_backoff_delay_ms: Maximum delay for a failed callback in milliseconds

  • callback_persist: Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required.

Auto Download setting

The "Auto Download" feature in Whapi.Cloud allows you to automatically download incoming media content to your Whapi channel, such as documents, photos, videos, and audio files sent to you in chats or groups.

Read more about this setting here: Setting "Auto Download"

With this setting enabled, our server will attempt to deliver notifications at 1 minute intervals even if your server has experienced some errors and is unavailable. You can make finer settings yourself through API using the method:

Update channel settings
Just pick the events you want