Webhook Filtering for "Show Ad Attribution" or ctwaClid Tags

[admdanielspalma]

Welcome!

• Yes, I have searched for similar requests on GitHub and found none.

What type of feature?

Integration

What is the motivation for the request?

Currently, the webhook sends all message events without filtering, leading to an overload of data, especially in traffic campaigns where only specific interactions are important for conversion tracking. This feature request aims to implement a filtering option that only triggers webhooks when a message includes relevant tags, such as ctwaClid or showAdAttribution. These tags are critical for Meta (Facebook/Instagram) ad traffic managers to correctly attribute conversions.

Given that ctwaClid and showAdAttribution are specific features provided by Meta, which directly tie into Facebook's marketing ecosystem, it makes complete sense for the Evolution API to handle these parameters effectively. As many Evolution API users rely on this integration for their marketing and advertising efforts, supporting this functionality would significantly improve their ability to track campaign performance and manage attribution with greater precision.

The feature would optimize the data flow, ensuring that only crucial information for conversion attribution is received. It would reduce unnecessary data processing and improve accuracy when tracking ad campaign conversions.

Usage Examples

Ad Conversion Tracking: When a user clicks on an ad and interacts via WhatsApp, the message webhook would include either the ctwaClid parameter or showAdAttribution: true. By filtering for these tags, the webhook system ensures that only relevant ad-related interactions are processed, enabling more precise campaign performance analysis.

Streamlined Message Processing: Businesses receiving high volumes of messages would benefit, as the webhook would only trigger for messages linked to ad campaigns, identified by the ctwaClid or showAdAttribution tags, significantly reducing the amount of irrelevant data being processed.

How should the feature be developed?

One possible solution is to implement a custom webhook destination that only triggers if the message body contains specific information. This could be achieved by allowing users to configure a regular expression (regex) filter that checks for specific tags in the webhook payload, such as ctwaClid or showAdAttribution. The webhook would only fire if the body of the message matches the defined regex pattern.

This approach makes even more sense as both ctwaClid and showAdAttribution are features deeply tied to Meta's advertising infrastructure. Many users of Evolution API are marketers who rely on these tags to track ad performance and conversions. By allowing the webhook to filter based on these parameters, it would directly align with how users work with Facebook ads, making the platform more efficient for this purpose.

Alternative: A middleware service could act as a filtering layer, receiving all webhooks and processing them based on the regex filter before forwarding only the relevant ones to the final destination.

Potential Impact: By focusing only on specific tags related to ad conversions, this feature would significantly enhance the accuracy and efficiency of the conversion tracking process while reducing the volume of irrelevant webhook data.

Additional Notes

No response