Skip to content

feat(chatwoot): capture ad-referral metadata from WhatsApp ads #2683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edneymatias wants to merge 2 commits into
base: main
Choose a base branch
from
+118 −32
Open

feat(chatwoot): capture ad-referral metadata from WhatsApp ads #2683

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
508f075
feat(chatwoot): capture ad-referral metadata from WhatsApp ads and ad…
edneymatias Aug 11, 2026
9439537
fix(chatwoot): keep ad-referral messages flowing when thumbnail fetch…
edneymatias Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 118 additions & 32 deletions src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,6 +931,7 @@ export class ChatwootService {
messageBody?: any,
sourceId?: string,
quotedMsg?: MessageModel,
referral?: Record<string, string>,
) {
const client = await this.clientCw(instance);

Expand All @@ -943,6 +944,12 @@ export class ChatwootService {

const sourceReplyId = quotedMsg?.chatwootMessageId || null;

let contentAttributes: Record<string, unknown> = { ...replyToIds };

if (referral) {
contentAttributes = { ...contentAttributes, referral };
}

const message = await client.messages.create({
accountId: this.provider.accountId,
conversationId: conversationId,
Expand All @@ -952,9 +959,7 @@ export class ChatwootService {
attachments: attachments,
private: privateMessage || false,
source_id: sourceId,
content_attributes: {
...replyToIds,
},
content_attributes: contentAttributes,
source_reply_id: sourceReplyId ? sourceReplyId.toString() : null,
},
});
Expand Down Expand Up @@ -1057,6 +1062,7 @@ export class ChatwootService {
messageBody?: any,
sourceId?: string,
quotedMsg?: MessageModel,
referral?: Record<string, string>,
) {
if (sourceId && this.isImportHistoryAvailable()) {
const messageAlreadySaved = await chatwootImport.getExistingSourceIds([sourceId], conversationId);
Expand All @@ -1079,17 +1085,24 @@ export class ChatwootService {

const sourceReplyId = quotedMsg?.chatwootMessageId || null;

let contentAttributes: Record<string, unknown> = {};

if (messageBody && instance) {
const replyToIds = await this.getReplyToIds(messageBody, instance);

if (replyToIds.in_reply_to || replyToIds.in_reply_to_external_id) {
const content = JSON.stringify({
...replyToIds,
});
data.append('content_attributes', content);
contentAttributes = { ...contentAttributes, ...replyToIds };
}
}

if (referral) {
contentAttributes = { ...contentAttributes, referral };
}

if (Object.keys(contentAttributes).length > 0) {
data.append('content_attributes', JSON.stringify(contentAttributes));
}

if (sourceReplyId) {
data.append('source_reply_id', sourceReplyId.toString());
}
Expand Down Expand Up @@ -1727,21 +1740,55 @@ export class ChatwootService {
body: string;
thumbnailUrl: string;
sourceUrl: string;
sourceId?: string;
sourceType?: string;
mediaType?: string;
mediaUrl?: string;
}

const externalAdReply =
msg.extendedTextMessage?.contextInfo?.externalAdReply ||
msg.contextInfo?.externalAdReply ||
msg.message?.extendedTextMessage?.contextInfo?.externalAdReply ||
msg.message?.contextInfo?.externalAdReply;

const adsMessage: AdsMessage | undefined = {
title: msg.extendedTextMessage?.contextInfo?.externalAdReply?.title || msg.contextInfo?.externalAdReply?.title,
body: msg.extendedTextMessage?.contextInfo?.externalAdReply?.body || msg.contextInfo?.externalAdReply?.body,
thumbnailUrl:
msg.extendedTextMessage?.contextInfo?.externalAdReply?.thumbnailUrl ||
msg.contextInfo?.externalAdReply?.thumbnailUrl,
sourceUrl:
msg.extendedTextMessage?.contextInfo?.externalAdReply?.sourceUrl || msg.contextInfo?.externalAdReply?.sourceUrl,
title: externalAdReply?.title,
body: externalAdReply?.body,
thumbnailUrl: externalAdReply?.thumbnailUrl,
sourceUrl: externalAdReply?.sourceUrl,
sourceId: externalAdReply?.sourceId,
sourceType: externalAdReply?.sourceType,
mediaType: externalAdReply?.mediaType,
mediaUrl: externalAdReply?.mediaUrl,
};

return adsMessage;
}

private buildReferralAttributes(adsMessage: {
title?: string;
body?: string;
thumbnailUrl?: string;
sourceUrl?: string;
sourceId?: string;
sourceType?: string;
mediaType?: string;
mediaUrl?: string;
}) {
const referral: Record<string, string> = {};

if (adsMessage.sourceId) referral.source_id = adsMessage.sourceId;
if (adsMessage.sourceType) referral.source_type = adsMessage.sourceType;
if (adsMessage.sourceUrl) referral.source_url = adsMessage.sourceUrl;
if (adsMessage.title) referral.headline = adsMessage.title;
if (adsMessage.body) referral.body = adsMessage.body;
if (adsMessage.mediaType) referral.media_type = adsMessage.mediaType;
if (adsMessage.thumbnailUrl) referral.image_url = adsMessage.thumbnailUrl;

return Object.keys(referral).length > 0 ? referral : undefined;
}

private getReactionMessage(msg: any) {
interface ReactionMessage {
key: {
Expand Down Expand Up @@ -2212,50 +2259,89 @@ export class ChatwootService {

const isAdsMessage = (adsMessage && adsMessage.title) || adsMessage.body || adsMessage.thumbnailUrl;
if (isAdsMessage) {
const imgBuffer = await axios.get(adsMessage.thumbnailUrl, { responseType: 'arraybuffer' });
const truncStr = (str: string, len: number) => {
if (!str) return '';

return str.length > len ? str.substring(0, len) + '...' : str;
};

const title = truncStr(adsMessage.title, 40);
const description = truncStr(adsMessage?.body, 75);
const referralAttributes = this.buildReferralAttributes(adsMessage);
const adCaption = `${bodyMessage}\n\n\n**${title}**\n${description}\n${adsMessage.sourceUrl}`;

const sendWithoutThumbnail = async () => {
const send = await this.createMessage(
instance,
getConversation,
adCaption,
messageType,
false,
[],
body,
'WAID:' + body.key.id,
quotedMsg,
referralAttributes,
);

if (!send) {
this.logger.warn('message not sent');
return;
}

return send;
};

let imgBuffer;
try {
imgBuffer = await axios.get(adsMessage.thumbnailUrl, { responseType: 'arraybuffer' });
} catch (error) {
this.logger.warn(`Failed to download ads thumbnail: ${error?.message || error}`);
return sendWithoutThumbnail();
}

const extension = mimeTypes.extension(imgBuffer.headers['content-type']);
const mimeType = extension && mimeTypes.lookup(extension);

if (!mimeType) {
this.logger.warn('mimetype of Ads message not found');
return;
return sendWithoutThumbnail();
}

const random = Math.random().toString(36).substring(7);
const nameFile = `${random}.${mimeTypes.extension(mimeType)}`;
const fileData = Buffer.from(imgBuffer.data, 'binary');

const img = await Jimp.read(fileData);
await img.cover({
w: 320,
h: 180,
});
const processedBuffer = await img.getBuffer(JimpMime.png);
let processedBuffer: Buffer = fileData;
try {
const img = await Jimp.read(fileData);
await img.cover({
w: 320,
h: 180,
});
processedBuffer = await img.getBuffer(JimpMime.png);
} catch (error) {
this.logger.warn(
`Failed to process ads thumbnail with Jimp, sending raw image: ${error?.message || error}`,
);
}

const fileStream = new Readable();
fileStream._read = () => {}; // _read is required but you can noop it
fileStream.push(processedBuffer);
fileStream.push(null);

const truncStr = (str: string, len: number) => {
if (!str) return '';

return str.length > len ? str.substring(0, len) + '...' : str;
};

const title = truncStr(adsMessage.title, 40);
const description = truncStr(adsMessage?.body, 75);

const send = await this.sendData(
getConversation,
fileStream,
nameFile,
messageType,
`${bodyMessage}\n\n\n**${title}**\n${description}\n${adsMessage.sourceUrl}`,
adCaption,
instance,
body,
'WAID:' + body.key.id,
quotedMsg,
referralAttributes,
);

if (!send) {
Expand Down