Define Events

PATCH 
/api/v2/instance/:instanceId/webhook/:webhookId/events

Webhook Events

Define the events that will be sent by the webhook to your system.

See here the table listing all events.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

webhookId stringrequired

ID of the Webhook

application/json

Body

required

• qrcodeUpdate: Enables sending the qr code.
• statusInstance: Enables sending instance status.
• messagesSet: Enables batch sending of old messages.
• messagesUpsert: Enables sending of all new incoming messages.
• messagesUpdate: Enables sending all updates to the incoming or outgoing message.
• sendMessage: Enables the sending of all messages sent by the API.
• contactsSet: Enables sending the initial batch of loaded contacts.
• contactsUpsert: Enables sending a new contact with additional information.
• contactsUpdate: Enable update notification for each contact in the conversation.
• presenceUpdate: Enables notification of contact behavior in chat.
• chatsSet: Enables sending all loaded chats.
• chatsUpdate: Enable notification of each chat update in the conversation.
• chatsUpsert: Enable notification of every new chat started.
• chatsDelete: Enable notification when a chat is deleted. deprecated
• groupsUpsert: Enable notification when a group is created.
• groupUpdate: Enable notification when a group is updated.
• groupParticipantsUpdate: Enable notification when a member of a group is updated.
• connectionUpdate: Enable notification when connection status changes.
• newJwt: Enable notification when the json web token is updated.
  1. Only for jwt authentication type.

qrcodeUpdate QrCode Update

Default value: true

Enables sending the qr code.

stateInstance State Instance

Default value: true

Enables sending instance State.

messagesSet Messages Set

Default value: true

Enables batch sending of old messages.

messagesUpsert Messages Upsert

Default value: true

Enables sending of all new incoming messages.

messagesUpdate Messages Update

Default value: true

Enables sending all updates to the incoming or outgoing message.

sendMessage Send Message

Default value: true

Enables the sending of all messages sent by the API.

contactsSet Contacts Set

Default value: true

Enables sending the initial batch of loaded contacts.

contactsUpsert Contacts Upsert

Default value: true

Enables sending a new contact with additional information.

contactsUpdate Contacts Update

Default value: true

Enable update notification for each contact in the conversation.

presenceUpdate Presence Update

Default value: true

Enables notification of contact behavior in chat.

chatsSet Chat Set

Default value: true

Enables sending all loaded chats.

chatsUpdate Chat Set

Default value: true

Enable notification of each chat update in the conversation.

chatsUpsert Chat Upsert

Default value: true

Enable notification of every new chat started.

chatsDelete Chat Deletedeprecated

Default value: true

Enable notification when a chat is deleted.

groupsUpsert Group Upsert

Default value: true

Enable notification when a group is created.

groupUpdate Group Update

Default value: true

c

groupParticipantsUpdate Group Participant Update

Default value: true

Enable notification when a member of a group is updated.

connectionUpdate Connection Update

Default value: true

Enable notification when connection status changes.

newJwt New Jwt

Default value: true

Enable notification when the json web token is updated.

Responses

201

WebhookResponse

application/json

Schema

Schema

name Namerequired

Identification name of your webhook

url Urlrequired

Instance unique url.

enabled Enabled

Default value: false

Enable or disable the url.

webhookId stringrequired
createdAt date-timerequired
updatedAt date-timerequired
instanceInstanceId stringrequired
WebhookEvents object
qrcodeUpdate QrCode Update
Default value: true
Enables sending the qr code.
stateInstance State Instance
Default value: true
Enables sending instance State.
messagesSet Messages Set
Default value: true
Enables batch sending of old messages.
messagesUpsert Messages Upsert
Default value: true
Enables sending of all new incoming messages.
messagesUpdate Messages Update
Default value: true
Enables sending all updates to the incoming or outgoing message.
sendMessage Send Message
Default value: true
Enables the sending of all messages sent by the API.
contactsSet Contacts Set
Default value: true
Enables sending the initial batch of loaded contacts.
contactsUpsert Contacts Upsert
Default value: true
Enables sending a new contact with additional information.
contactsUpdate Contacts Update
Default value: true
Enable update notification for each contact in the conversation.
presenceUpdate Presence Update
Default value: true
Enables notification of contact behavior in chat.
chatsSet Chat Set
Default value: true
Enables sending all loaded chats.
chatsUpdate Chat Set
Default value: true
Enable notification of each chat update in the conversation.
chatsUpsert Chat Upsert
Default value: true
Enable notification of every new chat started.
chatsDelete Chat Deletedeprecated
Default value: true
Enable notification when a chat is deleted.
groupsUpsert Group Upsert
Default value: true
Enable notification when a group is created.
groupUpdate Group Update
Default value: true
c
groupParticipantsUpdate Group Participant Update
Default value: true
Enable notification when a member of a group is updated.
connectionUpdate Connection Update
Default value: true
Enable notification when connection status changes.
newJwt New Jwt
Default value: true
Enable notification when the json web token is updated.
webhookEventsId stringrequired
createdAt date-timerequired
updatedAt date-timerequired

Example (from schema)

{
  "name": "string",
  "url": "string",
  "enabled": false,
  "webhookId": "string",
  "createdAt": "2024-04-14T14:11:05.671Z",
  "updatedAt": "2024-04-14T14:11:05.671Z",
  "instanceInstanceId": "string",
  "WebhookEvents": {
    "qrcodeUpdate": true,
    "stateInstance": true,
    "messagesSet": true,
    "messagesUpsert": true,
    "messagesUpdate": true,
    "sendMessage": true,
    "contactsSet": true,
    "contactsUpsert": true,
    "contactsUpdate": true,
    "presenceUpdate": true,
    "chatsSet": true,
    "chatsUpdate": true,
    "chatsUpsert": true,
    "groupsUpsert": true,
    "groupUpdate": true,
    "groupParticipantsUpdate": true,
    "connectionUpdate": true,
    "newJwt": true,
    "webhookEventsId": "string",
    "createdAt": "2024-04-14T14:11:05.671Z",
    "updatedAt": "2024-04-14T14:11:05.671Z"
  }
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...