For AI agents: visit https://gowapi.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

v1.0

API Reference

v1.0API Reference

GOWAPI - WhatsApp HTTP API

🖥️ Sessions (Devices)
📱 Pairing Connection
- Get QR code for pairing WhatsApp API.get
- Request authentication code.post
🆔 Profile
📤 Chatting
✅ Presence
📢 Channels
🟢 Status
💬 Chats
🔑 Api Keys
👤 Contacts
👥 Groups
📞 Calls
- Reject incoming callpost
📅 Events
- Send an event messagepost
🏷️ Labels
🖼️ Media
- Convert voice to WhatsApp format (opus)post
- Convert video to WhatsApp format (mp4)post

WEBHOOK

call.accepted
- The event is triggered when the call is accepted by the user.post
call.received
- The event is triggered when the call is received by the user.post
call.rejected
- The event is triggered when the call is rejected by the user.post
chat.archive
- The event is triggered when the chat is archived or unarchivedpost
engine.event
- Internal engine event.post
event.response
- The event is triggered when the event response is received.post
event.response.failed
- The event is triggered when the event response is failed to decrypt.post
group.join
- Some one join a group.post
group.leave
- Some one left a group.post
group.v2.join
- When you joined or were added to a grouppost
group.v2.leave
- When you left or were removed from a grouppost
group.v2.participants
- When participants changed - join, leave, promote to adminpost
group.v2.update
- When group info is updatedpost
label.chat.added
- The event is triggered when a label is added to a chatpost
label.chat.deleted
- The event is triggered when a label is deleted from a chatpost
label.deleted
- The event is triggered when a label is deletedpost
label.upsert
- The event is triggered when a label is created or updatedpost
message
- Incoming message.post
message.ack
- Receive events when server or recipient gets the message, read or played it (contacts only).post
message.ack.group
- Receive events when participants in a group read or play messages.post
message.any
- Fired on all message creations, including your own.post
message.edited
- The event is triggered when a user edits a previously sent message.post
message.reaction
- The event is triggered when a user reacts or removes a reaction.post
message.revoked
- The event is triggered when a user, whether it be you or any other participant, revokes a previously sent message.post
poll.vote
- With this event, you receive new votes for the poll sent.post
poll.vote.failed
- There may be cases when it fails to decrypt a vote from the user. Read more about how to handle such events in the documentations.post
presence.update
- The most recent presence information for a chat.post
session.status
- The event is triggered when the session status changes.post
state.change
- It’s an internal engine’s state, not session status.post

Powered by

WEBHOOK
label.chat.deleted

The event is triggered when a label is deleted from a chat

wbhk

label.chat.deleted

Payload

id

string

required

Unique identifier for the event - lower case ULID format. https://github.com/ulid/spec

timestamp

number

required

Unix timestamp (ms) for when the event was created.

session

string

required

metadata

object

Metadata for the session.

engine

string

enum

required

Allowed:

event

object

enum

required

The event is triggered when a label is deleted from a chat

payload

object

required

me

object

environment

object

required

Response

200

Return a 200 status to indicate that the data was received successfully

Updated 7 months ago

The event is triggered when a label is added to a chat

Did this page help you?

Loading…

Updated 7 months ago

The event is triggered when a label is added to a chat

Did this page help you?