For the complete documentation index, see llms.txt. This page is also available as Markdown.

Channel Settings overview

This article lists every parameter available in Whapi.Cloud channel settings

Webhooks

Webhook technology allows you to fulfill incoming notifications directly to your server. Some settings can be done through the interface.

Full info: webhooks overview

Core parameters

Parameter
Values
Description

url

required

The address where notifications will be sent

mode

body / path / method

How the event is transmitted in the request

events

messages, statuses, chats, contacts, presences, groups, calls, labels, users, channel, service

Which event types to track

Mode options:

  • body β€” all information about the event in the request body (default option)

  • path β€” the event type is added to the URL, e.g. .../message/post

  • method β€” the event type determines the HTTP method of the request, e.g. PATCH .../message

Update types

For each event type, you also specify an update type. Update type β‰  HTTP method.

Update type
Meaning

post

created

put

full update

patch

partial update

delete

deleted

Privacy

  • headers β€” custom headers for verifying that a webhook request really came from Whapi (e.g. a secret token your server checks on receipt). Can only be configured via API β€” not available in the panel.

Undecrypted messages

Can only be configured via API β€” not available in the panel.

Parameter
Values
Description

send_undecrypted_ad

default false

Send a webhook even for an undecrypted message if it's the first message in a new chat. Useful for tracking Click-to-WhatsApp ad campaigns β€” the webhook still arrives even if the ad message text itself couldn't be immediately decrypted

webhook_max_age_seconds

15 sec – 2 days

If a message decrypts later than the specified time, its webhook won't be sent. Prevents your bot from being flooded with webhooks for very outdated messages

Guaranteed webhooks

  • callback_persist β€” turns retry behavior on; also stores undelivered webhooks on disk until acknowledged. Requires a channel restart.

  • callback_backoff_delay_ms β€” delay before the first retry, growing with each failure. Api only

  • max_callback_backoff_delay_ms β€” the cap on that delay. Api only

Media

Parameter
Description

auto_download

Adds a direct link to the media file contained in the message, both in the webhook and in GET request responses. Media types: images, documents, video, audio

init_avatars

If true, contact/chat avatars are automatically fetched after channel authorization. Api only

{% hint style="info" %} Full info: Setting Auto Download {% endhint %}

Other params

Parameter
Description

proxy

Allows you to add a SOCKS5 proxy. Reduces WhatsApp's suspicions related to IP channel and phone region mismatches, improving session stability and reducing the risk of blocking

mobile_proxy

Beta-only parameter β€” not in use, ignored in production. Api only

offline_mode

Prevents the channel from sending an "online" status on connection, so push notifications keep arriving on the iPhone. Api only

full_history

Allows you to access the entire message history available in WhatsApp after reconnecting (instead of partial). Working after reconnect. Api only

auto_read_messages

Automatically marks incoming messages as read as soon as they're received. Api only

ignored_presences

A list of contacts whose presence events (online/typing) should not be sent to the webhook (unsubscribe from presence). Api only

data_mode

Identifier format: LID, phone number, or both at once (beta). Api only

pdo_sync

Stops retrying to decrypt old messages; fixes the looping/infinite push notification issue on iPhone. Api only

Examples

Example of full channel settings payload

default (empty) channel settings

Last updated