node-tracker.buildconsentwithdrawn

Home > @snowplow/node-tracker > buildConsentWithdrawn

buildConsentWithdrawn() function

Build a Consent Withdrawn Event Used for tracking when a user withdraws their consent

Signature:

declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): {
    event: PayloadBuilder;
    context: {
        schema: string;
        data: Record<string, unknown>;
    }[];
};

Parameters

Parameter	Type	Description
event	ConsentWithdrawnEvent	Contains the properties for the Consent Withdrawn event

Returns:

{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }\[\]; }

An object containing the PayloadBuilder to be sent to and a 'consent_document' context