Skip to content

fix(chatwoot): findContactByIdentifier runtime crash 'TypeError: client.get is not a function' & LID fallback issue #2795

Open

Description

@md-riaz

Description

When using the native Chatwoot integration with Evolution API, a critical runtime error occurs that causes incoming WhatsApp messages to fail and get dropped silently in ChatwootService:

TypeError: t.get is not a function in findContactByIdentifier:
When an incoming message arrives and Chatwoot returns 422 Unprocessable Entity on contact creation (e.g., when the identifier or phone number is already associated with an existing contact in Chatwoot), Evolution API attempts to recover by calling findContactByIdentifier(instance, identifier).

Inside findContactByIdentifier, it calls:

const contact = (await (client as any).get('contacts/search', { params: { q: identifier, sort: 'name' } }));

However, at runtime, the ChatwootClient instance returned by clientCw does not expose a root .get() method. It crashes with:

ERROR [ChatwootService] Error in createConversation: TypeError: t.get is not a function
WARN  [ChatwootService] conversation not found

Additionally, in createConversation:

const i = s && !a ? t.key.remoteJidAlt : t.key.remoteJid;

When a user sends a message from a Linked Device / WhatsApp privacy mode where remoteJidAlt is undefined in that packet, i becomes undefined, causing downstream calls like i.split('@')[0] to throw TypeError: Cannot read properties of undefined (reading 'split').


Steps to Reproduce

  1. Connect WhatsApp with Chatwoot native integration enabled (/chatwoot/set/:instance).
  2. In Chatwoot, have an existing contact where identifier matches the incoming sender's WhatsApp JID but the stored phone number differs or has conflict.
  3. Send a message to the instance from that WhatsApp number.
  4. Chatwoot returns 422 on contact creation because the identifier is already registered.
  5. Evolution API enters the 422 catch block and executes this.findContactByIdentifier(...).
  6. Watch Evolution API logs throw TypeError: t.get is not a function and fail to create the conversation.

Source Code References

File: src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts

  1. findContactByIdentifier runtime failure:

    async findContactByIdentifier(instance: InstanceDto, identifier: string) {
      const client = await this.clientCw(instance);
      if (!client) {
        this.logger.warn('client not found');
        return null;
      }
    
      // BUG: client is a ChatwootClient instance, not an Axios instance. Calling .get() fails at runtime.
      const contact = (await (client as any).get('contacts/search', {
        params: { q: identifier, sort: 'name' },
      })) as any;
    
  2. LID remoteJidAlt undefined issue:

    // BUG: if remoteJidAlt is undefined, i becomes undefined
    const i = s && !a ? t.key.remoteJidAlt : t.key.remoteJid;
    

Suggested Fix

  1. In findContactByIdentifier, query contacts via client.contacts.search:

    async findContactByIdentifier(instance: InstanceDto, identifier: string) {
      const client = await this.clientCw(instance);
      if (!client) {
        this.logger.warn('client not found');
        return null;
      }
    
      try {
        const res = await client.contacts.search({
          accountId: this.provider.accountId,
          q: identifier,
        });
        if (res?.payload?.length > 0) {
          return res.payload[0];
        }
      } catch (err) {
        this.logger.error(`Error searching contact by identifier: ${err}`);
      }
      return null;
    }
    
  2. In createConversation, fallback to t.key.remoteJid if remoteJidAlt is missing:

    const i = s && !a ? (t.key.remoteJidAlt || t.key.remoteJid) : t.key.remoteJid;
    

Environment

  • Evolution API Version: v2.3.7
  • Chatwoot Version: v3.x / v4.x
  • Deployment: Docker / Linux

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions