Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Gift Up!

Scalekit connector
Open markdown

The Gift Up! connector lets your AI agent act in each user's Gift Up! account. Each user connects their own Gift Up! access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 48 tools.

Tools
48
What they doRead · write · destructive
23 · 19 · 623 read19 write6 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Gift Up! connection

    In AgentKit > Connections, create a Gift Up! connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'giftup'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Gift Up!:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'giftup_checkout_settings_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Gift Up! credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • giftup_checkout_settings_getGet the checkout's appearance and behaviour settings: logo, intro text, fonts, colors, links and service fees.Read-only

    Get Checkout Settings

    Get the checkout's appearance and behaviour settings: logo, intro text, fonts, colors, links and service fees. Returns the settings.

    Inputs

    This tool takes no inputs.

  • giftup_company_getGet the Gift Up company (account) behind the API key: name, currency, time zone and settings.Read-only

    Get Company

    Get the Gift Up company (account) behind the API key: name, currency, time zone and settings. Returns the company object. Use it as a connection check.

    Inputs

    This tool takes no inputs.

  • giftup_email_settings_getGet the default settings of gift card and receipt emails: logo, sender, subject lines and texts.Read-only

    Get Email Settings

    Get the default settings of gift card and receipt emails: logo, sender, subject lines and texts. Returns the settings.

    Inputs

    This tool takes no inputs.

  • giftup_gift_card_artwork_listList the uploaded gift card artwork images.Read-only

    List Gift Card Artwork

    List the uploaded gift card artwork images. Returns artwork IDs, URLs and sort order.

    Inputs

    This tool takes no inputs.

  • giftup_gift_card_getGet one gift card by code with its remaining balance, state flags (canBeRedeemed, hasExpired, isVoided), recipient, dates and ledger.Read-only

    Get Gift Card

    Get one gift card by code with its remaining balance, state flags (canBeRedeemed, hasExpired, isVoided), recipient, dates and ledger. Returns the gift card object. Check canBeRedeemed and remainingValue before accepting it.

    Inputs

    codestringrequired
    Gift card code. Example: GIFT-4XK2-9QPL.
  • giftup_gift_card_settings_getGet default gift card settings: description, barcode format, expiry, display options, general terms and code format.Read-only

    Get Gift Card Settings

    Get default gift card settings: description, barcode format, expiry, display options, general terms and code format. Returns the settings.

    Inputs

    This tool takes no inputs.

  • giftup_gift_cards_listList gift cards, newest first, filtered by state, creation or update time, order, SKU, recipient or purchaser email, or payment transaction ID, up to 100 per page.Read-only

    List Gift Cards

    List gift cards, newest first, filtered by state, creation or update time, order, SKU, recipient or purchaser email, or payment transaction ID, up to 100 per page. Returns gift cards with code, balance, state flags and a total count. Use giftup_gift_card_get to look up one code.

    Inputs

    created_on_or_afterstring
    Only gift cards created on or after this UTC date or time, for example 2026-01-01. Example: 2026-01-01.
    limitinteger
    Number of results to return, 1 to 100. Example: 25.
    offsetinteger
    Number of results to skip. Example: 0.
    order_idstring
    Only gift cards from this order ID. Example: 8b0e2f4a-1c3d-4e5f-9a7b-6c5d4e3f2a1b.
    payment_transaction_idstring
    Only gift cards whose payment provider transaction ID matches. Example: pi_3PqRsT2eZvKYlo2C1abcdEF.
    purchaser_emailstring
    Only gift cards bought by this email. Example: jane.doe@example.com.
    recipient_emailstring
    Only gift cards sent to this recipient email. Example: sam.lee@example.com.
    skustring
    Only gift cards with this private SKU. Example: GC-50.
    statusstring
    Only gift cards in this state. Example: active.one of activeexpiredredeemedvoided
    updated_on_or_afterstring
    Only gift cards updated on or after this UTC date or time. Example: 2026-01-15T00:00:00Z.
  • giftup_item_getGet one item by ID.Read-only

    Get Item

    Get one item by ID. Returns the item object.

    Inputs

    item_idstringrequired
    ID of the item, from giftup_items_list. Example: 2f1c9a7e-6b3d-4e8a-9c21-5d6f7a8b9c0d.