Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Booqable

Scalekit connector
Open markdown

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

Tools
50
What they doRead · write · destructive
32 · 14 · 432 read14 write4 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 Booqable connection

    In AgentKit > Connections, create a Booqable 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 = 'booqable'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Booqable:', 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: 'booqable_bundles_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Booqable 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
  • booqable_bundle_getGet one bundle; include bundle_items to see its contents.Read-only

    Get Bundle

    Get one bundle; include bundle_items to see its contents. Returns data with the bundles record's id and attributes. Get the ID from booqable_bundles_list.

    Inputs

    idstringrequired
    ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
    includestring
    List of comma seperated relationships to sideload. ?include=photo,bundle_items,tax_category. Example: bundle_items
  • booqable_bundles_listList bundles (packages of products rented together).Read-only

    List Bundles

    List bundles (packages of products rented together). Returns data, a list of bundles records (id, type, attributes), with sideloaded records in included. Use booqable_bundle_get for one bundle.

    Inputs

    archivedboolean
    Filter on archived (operators: eq). Example: true
    includestring
    List of comma seperated relationships to sideload. ?include=photo,inventory_levels. Example: photo
    pagestring
    The page to request. Example: 1
    page_sizestring
    The amount of items per page. Example: 25
    qstring
    Filter on q (operators: eq). Example: example
    sortstring
    How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
  • booqable_collections_listList store collections (product categories).Read-only

    List Collections

    List store collections (product categories). Returns data, a list of collections records (id, type, attributes), with sideloaded records in included. Use the collection ID to filter items in the online store.

    Inputs

    pagestring
    The page to request. Example: 1
    page_sizestring
    The amount of items per page. Example: 25
    parent_idstring
    Filter on parent_id (operators: eq, not_eq). Example: example
    qstring
    Filter on q (operators: eq). Example: example
    sortstring
    How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
  • booqable_company_getGet the Booqable company the token belongs to, with address, currency, timezone and plan details.Read-only

    Get Company

    Get the Booqable company the token belongs to, with address, currency, timezone and plan details. Returns data, a list of companies records (id, type, attributes), with sideloaded records in included. Use this to confirm the connection.

    Inputs

    This tool takes no inputs.

  • booqable_coupons_listList discount coupons with code, value, type and limits.Read-only

    List Coupons

    List discount coupons with code, value, type and limits. Returns data, a list of coupons records (id, type, attributes), with sideloaded records in included. Use booqable_coupon_create to add one.

    Inputs

    activeboolean
    Filter on active (operators: eq). Example: true
    archivedboolean
    Filter on archived (operators: eq). Example: true
    includestring
    List of comma seperated relationships to sideload. ?include=coupon_items. Example: coupon_items
    pagestring
    The page to request. Example: 1
    page_sizestring
    The amount of items per page. Example: 25
    qstring
    Filter on q (operators: eq). Example: example
    sortstring
    How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
  • booqable_customer_getGet one customer with contact details, deposit and discount defaults, tags and order totals.Read-only

    Get Customer

    Get one customer with contact details, deposit and discount defaults, tags and order totals. Returns data with the customers record's id and attributes. Get the customer ID from booqable_customers_list.

    Inputs

    idstringrequired
    ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
    includestring
    List of comma seperated relationships to sideload. ?include=barcode,properties,tax_region. Example: barcode
  • booqable_customers_listList customers, optionally searching by name or email (q) or filtering by email, tag or archived state.Read-only

    List Customers

    List customers, optionally searching by name or email (q) or filtering by email, tag or archived state. Returns data, a list of customers records (id, type, attributes), with sideloaded records in included. Use booqable_customer_get for one customer.

    Inputs

    archivedboolean
    Filter on archived (operators: eq). Example: true
    emailstring
    Filter on email (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: jane@example.com
    includestring
    List of comma seperated relationships to sideload. ?include=barcode,properties,tax_region. Example: barcode
    namestring
    Filter on name (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: Example name
    pagestring
    The page to request. Example: 1
    page_sizestring
    The amount of items per page. Example: 25
    qstring
    Filter on q (operators: eq). Example: example
    sortstring
    How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
    tag_liststring
    Filter on tag_list (operators: eq). Example: example
  • booqable_document_getGet one quote, contract or invoice with totals and status; include lines to sideload them.Read-only

    Get Document

    Get one quote, contract or invoice with totals and status; include lines to sideload them. Returns data with the documents record's id and attributes. Get the ID from booqable_documents_list.

    Inputs

    idstringrequired
    ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
    includestring
    List of comma seperated relationships to sideload. ?include=signature,coupon,properties. Example: lines