Sanity Library Reference Docs
    Preparing search index...

    Interface SendFeedbackOptions

    Options accepted by the sendFeedback function returned from useInStudioFeedback.

    interface SendFeedbackOptions {
        attachments?: { data: Uint8Array; filename: string }[];
        dsn: string;
        extraTags?: Record<string, TagValue>;
        feedbackVersion: string;
        message: string;
        source: string;
    }
    Index

    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]

    extraTags?: Record<string, TagValue>

    The tags to send with the feedback.

    feedbackVersion: string

    Tracks the tag schema for this feedback source. Bump when tags change.

    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)

    source: string

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