Skip to content

node-tracker.buildconsentwithdrawn.md

Latest commit

 

History

History
32 lines (21 loc) · 976 Bytes

node-tracker.buildconsentwithdrawn.md

File metadata and controls

32 lines (21 loc) · 976 Bytes
Raw

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