Webhooks Overview
Stream WhatsApp events to your server in real-time.
Webhooks Endpoints
Set Webhook URL
Creates a new webhook URL on an instance or updates an existing one, with a precise list of events to subscribe to. (Paid users only)
Update Webhook
Modifies an existing webhook URL on an instance: change subscribed events, enable/disable delivery, or update the retry policy. (Paid users only)
Delete Webhook URL
Removes a custom webhook URL from a WhatsApp instance. The system webhook cannot be deleted. (Paid users only)
Session Status Change
This event is triggered when the session status changes (e.g., from WORKING to STOPPED).
Incoming Message
This event is triggered when a new message is received by your WhatsApp instance.
Message Reaction
Triggered when a user reacts to a message with an emoji.
Any Message
Catch-all event for any message activity in the session.
Message Acknowledgement
Track message delivery and read status (sent, delivered, read).
Message Revoked
Triggered when a user deletes a message for everyone.
Message Edited
Triggered when a sent message is modified by the user.
Group Join (V2)
Triggered when a new member joins or is added to a group.
Group Leave (V2)
Triggered when a member leaves or is removed from a group.
Group Updated (V2)
Triggered when group settings like title, description, or icon are changed.
Group Participants Change
Triggered when participants are promoted to admin or demoted.
Presence Updated
Triggered when a contact starts typing, recording audio, or changes their online status.
Poll Vote Failed
Triggered if a vote on a poll fails to process correctly.
Chat Archived/Unarchived
Triggered when a chat's archive status changes.
Call Received
Triggered when an incoming Voice or Video call is detected.
Call Accepted
Triggered when a received call is picked up on another device.
Call Rejected
Triggered when an incoming call is declined.
Label Created/Updated
Triggered when a WhatsApp Business label is added or modified.
Label Deleted
Triggered when a label is completely removed from the account.
Label Added to Chat
Triggered when a label is assigned to a specific conversation.
Label Removed from Chat
Triggered when a label is unassigned from a conversation.
Event Success Response
Triggered when an asynchronous event completes successfully.
Event Failure Response
Triggered when an asynchronous event fails to complete.
Raw Engine Event
Catch-all for low-level system events directly from the WhatsApp engine.