Papier
Get started
InterfaceSDK v0.2.1

BuiltNotificationPayload

import type { BuiltNotificationPayload } from '@usepapier/client/base';

Declaration #

surfaces.tsTypeScript
export interface BuiltNotificationPayload<TPayload = any> {
    type: "notification";
    templateName: string;
    projectName: string;
    to: {
        fcmToken?: string;
        apnToken?: string;
        webPushSubscription?: {
            endpoint: string;
            keys: {
                p256dh: string;
                auth: string;
            };
        };
    };
    data?: TPayload;
}

Source: packages/client/src/core/surfaces.ts:30

Members 5

type

type: "notification";

packages/client/src/core/surfaces.ts:31

templateName

templateName: string;

packages/client/src/core/surfaces.ts:32

projectName

projectName: string;

packages/client/src/core/surfaces.ts:33

to

to: {
    fcmToken?: string;
    apnToken?: string;
    webPushSubscription?: {
        endpoint: string;
        keys: {
            p256dh: string;
            auth: string;
        };
    };
};

packages/client/src/core/surfaces.ts:34

data

Optional
data?: TPayload;

packages/client/src/core/surfaces.ts:39

Generated from TypeScript source.d65ea8f71fbf