Webhooks

Label Added to Chat

Triggered when a label is assigned to a specific conversation.

Best practices

  • Update the 'tags' or 'status' field for the contact/chat in your backend.

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Webhook Payload Example
application/json
string *
number *
string *
object *
string *
string *
object *
object *

Example

{
"id": "evt_01...",
"timestamp": 1634567890123,
"session": "default",
"metadata": {
  "user.id": "123",
  "user.email": "email@example.com"
  },
"engine": "WEBJS",
"event": "label.chat.added",
"payload": {
  "chatId": "11111111111@c.us",
  "labelId": "1"
  },
"me": {
  "id": "11111111111@c.us",
  "lid": "123@lid",
  "pushName": "Instance"
  }
}
Previous TopicLabel Deleted
Next TopicLabel Removed from Chat

Command Palette

Search for a command to run...