snowplow/snowplow-javascript-tracker

View on GitHub
api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md

Summary

Maintainability
Test Coverage
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [buildConsentWithdrawn](./node-tracker.buildconsentwithdrawn.md)

## buildConsentWithdrawn() function

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

<b>Signature:</b>

```typescript
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 |

<b>Returns:</b>

{ event: PayloadBuilder; context: { schema: string; data: Record&lt;string, unknown&gt;; }\[\]; }

An object containing the PayloadBuilder to be sent to  and a 'consent\_document' context