Sanity Library Reference Docs
    Preparing search index...

    Interface FeedbackPayload

    The full feedback payload sent to Sentry.

    interface FeedbackPayload {
        attachments?: { data: Uint8Array; filename: string }[];
        dsn: string;
        email?: string;
        feedbackVersion: string;
        message: string;
        name?: string;
        source: string;
        tags: Record<string, TagValue>;
        telemetryConsent: ConsentStatus;
    }
    Index

    Properties

    attachments? dsn email? feedbackVersion message name? source tags telemetryConsent

    Properties

    attachments?: { data: Uint8Array; filename: string }[]

    The attachments to send with the feedback.

    dsn: string

    Sentry DSN to send feedback to. Format: https://[key]@[host]/[project-id]

    email?: string

    The email of the user sending feedback.

    feedbackVersion: string

    Tracks the tag schema for this feedback source. Bump when tags or meaningful changes are made. Similar to version in telemetry consent.

    message: string

    The message the user is sending feedback. It's mandatory as without it, Sentry will ignore the feedback upon receiving it. (Mandatory Sentry field)

    name?: string

    The name of the user sending feedback.

    source: string

    The source of the feedback. Identifies where this feedback was triggered from (e.g. 'studio-help-menu').

    tags: Record<string, TagValue>

    The tags to send with the feedback.

    telemetryConsent: ConsentStatus

    The user's telemetry consent status. When not 'granted', PII (name, email, userId) is stripped and IP is anonymised.

    Settings

    Member Visibility

    On This Page

    Properties