Detailed webhook settings

Webhooks Mode / Request Method / Persist webhook / Auto Download

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.

Just pick the events you want

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)

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

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"

Last updated

Was this helpful?