webhook: improved types & examples

Author: gusnips

README.md

@@ -568,6 +568,7 @@ import express from "express";
 import {
   WebhookData,
   WebhookEvent,
+  WebhookEventSetup,
   MessagePayload,
   ContactPayload,
   ConnectionUpdatePayload,
@@ -808,6 +809,31 @@ The SDK supports all Evolution API webhook events:
 - `WebhookEvent.GROUP_PARTICIPANTS_UPDATE` - Group member changes
 - `WebhookEvent.NEW_TOKEN` - JWT token updates
 
+#### Available Webhook Events to Setup
+
+To setup the WebHook, the constants are these ones:
+
+- `WebhookEventSetup.APPLICATION_STARTUP` - API startup
+- `WebhookEventSetup.QRCODE_UPDATED` - QR code updates
+- `WebhookEventSetup.CONNECTION_UPDATE` - Connection status changes
+- `WebhookEventSetup.MESSAGES_SET` - Initial message load
+- `WebhookEventSetup.MESSAGES_UPSERT` - New messages
+- `WebhookEventSetup.MESSAGES_UPDATE` - Message status updates
+- `WebhookEventSetup.MESSAGES_DELETE` - Message deletions
+- `WebhookEventSetup.SEND_MESSAGE` - Message sending events
+- `WebhookEventSetup.CONTACTS_SET` - Initial contacts load
+- `WebhookEventSetup.CONTACTS_UPSERT` - New contacts
+- `WebhookEventSetup.CONTACTS_UPDATE` - Contact updates
+- `WebhookEventSetup.PRESENCE_UPDATE` - User presence changes
+- `WebhookEventSetup.CHATS_SET` - Initial chats load
+- `WebhookEventSetup.CHATS_UPDATE` - Chat updates
+- `WebhookEventSetup.CHATS_UPSERT` - New chats
+- `WebhookEventSetup.CHATS_DELETE` - Chat deletions
+- `WebhookEventSetup.GROUPS_UPSERT` - New groups
+- `WebhookEventSetup.GROUPS_UPDATE` - Group updates
+- `WebhookEventSetup.GROUP_PARTICIPANTS_UPDATE` - Group member changes
+- `WebhookEventSetup.NEW_TOKEN` - JWT token updates
+
 #### Configure Webhook URL
 
 Don't forget to configure your webhook URL in the Evolution API:
@@ -818,10 +844,10 @@ await client.webhook.set({
   url: "https://your-domain.com/webhook",
   webhook_by_events: true,
   events: [
-    "MESSAGES_UPSERT",
-    "MESSAGES_UPDATE",
-    "CONNECTION_UPDATE",
-    "CONTACTS_UPSERT",
+    WebhookEventSetup.MESSAGES_UPSERT,
+    WebhookEventSetup.MESSAGES_UPDATE,
+    WebhookEventSetup.CONNECTION_UPDATE,
+    WebhookEventSetup.CONTACTS_UPSERT,
   ],
 });
 ```

package.json

@@ -1,7 +1,7 @@
 {
   "name": "evolution-api-sdk",
   "private": false,
-  "version": "0.6.15",
+  "version": "0.6.16",
   "description": "Unofficial SDK for the Evolution Whatsapp API v2",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/types/webhooks.ts

@@ -190,3 +190,26 @@ export enum WebhookEvent {
   GROUP_PARTICIPANTS_UPDATE = "group.participants.update",
   NEW_TOKEN = "new.jwt",
 }
+
+export enum WebhookEventSetup {
+  APPLICATION_STARTUP = "APPLICATION_STARTUP",
+  QRCODE_UPDATED = "QRCODE_UPDATED",
+  CONNECTION_UPDATE = "CONNECTION_UPDATE",
+  MESSAGES_SET = "MESSAGES_SET",
+  MESSAGES_UPSERT = "MESSAGES_UPSERT",
+  MESSAGES_UPDATE = "MESSAGES_UPDATE",
+  MESSAGES_DELETE = "MESSAGES_DELETE",
+  SEND_MESSAGE = "SEND_MESSAGE",
+  CONTACTS_SET = "CONTACTS_SET",
+  CONTACTS_UPSERT = "CONTACTS_UPSERT",
+  CONTACTS_UPDATE = "CONTACTS_UPDATE",
+  PRESENCE_UPDATE = "PRESENCE_UPDATE",
+  CHATS_SET = "CHATS_SET",
+  CHATS_UPDATE = "CHATS_UPDATE",
+  CHATS_UPSERT = "CHATS_UPSERT",
+  CHATS_DELETE = "CHATS_DELETE",
+  GROUPS_UPSERT = "GROUPS_UPSERT",
+  GROUPS_UPDATE = "GROUPS_UPDATE",
+  GROUP_PARTICIPANTS_UPDATE = "GROUP_PARTICIPANTS_UPDATE",
+  NEW_TOKEN = "NEW_TOKEN",
+}