Preview

SpiffIncentive is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

SpiffIncentive

A single spiff/incentive promotion, normalized and ready for display.

This page contains

    Fields

    id: String!

    Stable identifier for the card. Falls back to {category}-{name} when axpi omits an id.

    category: SpiffCategory! PREVIEW

    Canonical Techwheel category, normalized from axpi tech_wheel_category.

    subcategory: String

    Comma-joined subcategory labels, when present.

    name: String!
    providerName: String!
    providerUrl: String

    HTTPS-only provider profile link; null when axpi provides a non-https or blank URL.

    providerLogoUrl: String
    description: String!

    Plain text description (HTML tags stripped and entities decoded).

    promoFlyerUrl: String

    Parent objects of SpiffIncentive

    SpiffsAndIncentives PREVIEW

    Spiffs/incentives payload with Provider Spiffs app assignment status.

    Queries for SpiffIncentive

    spiffsAndIncentives PREVIEW

    Retrieve up to 3 selected spiffs/incentives and Provider Spiffs app assignment for the authenticated advisor. Returns an empty spiffs list when none are eligible. personalizationKey is the browser-minted userExternalServiceAuthenticationToken used as the axpi Bearer token.