evolution-api-sdk/lib/types/webhooks.d.ts

Unofficial SDK for the Evolution Whatsapp API v2

interface DeviceListMetadata {
    senderKeyHash: string;
    senderTimestamp: string;
    recipientKeyHash: string;
    recipientTimestamp: string;
}
interface MessageContextInfo {
    deviceListMetadata?: DeviceListMetadata | Record<string, unknown>;
    deviceListMetadataVersion: number;
    messageSecret: string;
}
interface DisappearingMode {
    initiator: string;
    trigger: string;
    initiatedByMe: boolean;
}
interface ContextInfo {
    expiration?: number;
    ephemeralSettingTimestamp?: string;
    disappearingMode?: DisappearingMode;
    stanzaId?: string;
    participant?: string;
    quotedMessage?: {
        conversation?: string;
    };
    statusSourceType?: string;
}
interface ImageMessage {
    url: string;
    mimetype: string;
    fileSha256: string;
    fileLength: string;
    height: number;
    width: number;
    mediaKey: string;
    fileEncSha256: string;
    directPath: string;
    mediaKeyTimestamp: string;
    jpegThumbnail: string;
    contextInfo?: ContextInfo;
    firstScanSidecar: string;
    firstScanLength: number;
    scansSidecar: string;
    scanLengths: number[];
    midQualityFileSha256: string;
    imageSourceType: string;
}
interface AudioMessage {
    url: string;
    mimetype: string;
    fileSha256: string;
    fileLength: string;
    seconds: number;
    ptt: boolean;
    mediaKey: string;
    fileEncSha256: string;
    directPath: string;
    mediaKeyTimestamp: string;
    waveform: string;
}
interface StickerMessage {
    url: string;
    width: number;
    height: number;
    isAvatar: boolean;
    isLottie: boolean;
    mediaKey: string;
    mimetype: string;
    directPath: string;
    fileLength: string;
    fileSha256: string;
    isAnimated: boolean;
    isAiSticker: boolean;
    fileEncSha256: string;
    stickerSentTs: string;
    mediaKeyTimestamp: string;
}
interface ExtendedTextMessage {
    text: string;
    contextInfo?: ContextInfo;
}
type MessageContent = {
    messageContextInfo?: MessageContextInfo;
    conversation?: string;
    extendedTextMessage?: ExtendedTextMessage;
    imageMessage?: ImageMessage;
    audioMessage?: AudioMessage;
    stickerMessage?: StickerMessage;
};
interface MessageUpdate {
    status: string;
}
interface ConnectionUpdatePayload {
    instance: string;
    wuid?: string;
    profileName?: string;
    profilePictureUrl?: string | null;
    state: string;
    statusReason: number;
}
interface ContactPayload {
    remoteJid: string;
    pushName: string;
    profilePicUrl: string | null;
    instanceId: string;
}
interface MessagePayload {
    key: {
        remoteJid: string;
        fromMe: boolean;
        id: string;
        senderLid?: string;
    };
    pushName?: string;
    message?: MessageContent;
    messageType?: string;
    messageTimestamp?: number;
    status?: string;
    participant?: string;
    contextInfo?: ContextInfo;
    instanceId?: string;
    source?: string;
}
interface WebhookData {
    event: string;
    instance: string;
    data: MessagePayload | ContactPayload | ContactPayload[] | ConnectionUpdatePayload;
    sender: string;
    date?: number;
    instanceName?: string;
    destination?: string;
    date_time?: string;
    server_url?: string;
    apikey?: string;
}
interface Instance {
    instanceName: string;
    status: string;
    qrcode?: string;
}
interface Message {
    key: {
        remoteJid: string;
        fromMe: boolean;
        id: string;
    };
    message: Record<string, unknown>;
    messageTimestamp: number;
    pushName?: string;
}
declare enum WebhookEvent {
    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.jwt"
}
declare 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"
}

export { type AudioMessage, type ConnectionUpdatePayload, type ContactPayload, type ContextInfo, type DeviceListMetadata, type DisappearingMode, type ExtendedTextMessage, type ImageMessage, type Instance, type Message, type MessageContent, type MessageContextInfo, type MessagePayload, type MessageUpdate, type StickerMessage, type WebhookData, WebhookEvent, WebhookEventSetup };