Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Airship

Scalekit connector
Open markdown

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

Tools
62
What they doRead · write · destructive
25 · 29 · 825 read29 write8 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 Airship connection

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

    Each user opens the link once and enters their Airship 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
  • airship_channel_getFetch an individual channel registered to the app key, along with associated data and metadata.Read-only

    Channel lookup

    Fetch an individual channel registered to the app key, along with associated data and metadata. Returns an object with channel, ok. Use this when you have the ID. Use airship_channels_list to find one. Needs channel_id from airship_channels_list.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    channel_idstringrequired
    The unique channel identifier. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5
  • airship_channels_listList all channels registered to this app key, along with associated data and metadata.Read-only

    Channel listing

    List all channels registered to this app key, along with associated data and metadata. Returns channels, an array of items with address, attributes, background, channel_id, commercial_opted_in, commercial_opted_out, created, device_attributes, device_type, email_address, plus next_page, ok. Use this to browse. Use airship_channel_get when you already have the ID.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    limitinteger
    The default limit is 1,000 channel objects returned per request. Set the limit to 1,000 or fewer in your API calls. Example: 10
  • airship_contact_id_by_channel_getLook up a contact ID for the given channel ID.Read-only

    Look Up Contact ID by Channel

    Look up a contact ID for the given channel ID. Returns an object with contact_id, is_anonymous, ok.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    channel_idstringrequired
    The channel ID for which to retrieve the associated contact ID. Example: 3f1c2b9e-6a4d-4e1b-9c2a-7d8e5f4a1b2c
  • airship_contact_id_by_named_user_getLook up a contact ID for the given named user ID.Read-only

    Look Up Contact ID by Named User

    Look up a contact ID for the given named user ID. Returns an object with contact_id, ok.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    named_user_idstringrequired
    The URL-encoded named user ID for which to retrieve the associated contact ID. Example: user-123
  • airship_create_and_send_validateValidate a create-and-send payload without registering channels or sending.Read-only

    Validate Create and Send Message

    Validate a create-and-send payload without registering channels or sending. Returns ok true when Airship would accept the payload. Use this before airship_create_and_send. It sends nothing.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    audienceobjectrequired
    Who receives the message. For create and send, list the addresses to register and message under create_and_send, each with ua_address and opt-in timestamps. Example: {"create_and_send": [{"ua_address": "jane@example.com", "ua_commercial_opted_in": "2026-01-15T09:30:00"}]}
    device_typesarrayrequired
    The platform you want to send notifications to. Example: ["email"]
    notificationobjectrequired
    An `alert` notification or a platform override matching the value in `device types`. A notification with a platform override that does not match your `device_types` will result in a 400 error. Example: {"email": {"subject": "Your order shipped", "html_body": "<p>Order A-1001 shipped.</p>", "plaintext_body": "Order A-1001 shipped.", "message_type": "transactional", "sender_name": "Acme", "sender_address": "orders@acme.example", "reply_to": "support@acme.example"}}
    campaignsobject
    An object specifying custom campaign categories related to the notification. Example: {"categories": ["winter sale", "west coast"]}
  • airship_email_channel_getReturn a channel by email address.Read-only

    Look up an email address

    Return a channel by email address. For security, email addresses are one-way hashed and aren't returned when you look up a channel by ID. Returns an object with channel, ok.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    emailstringrequired
    The email address of the channel you want to look up. Example: jane@example.com
  • airship_named_user_subscription_lists_getNamed user subscription lists listing.Read-only

    Named user subscription lists listing

    Named user subscription lists listing. Provides the subscription lists that are associated with a given named user. Returns an object with ok, subscription_lists.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    named_user_idstringrequired
    The named user being looked up. Example: user-123
  • airship_named_users_listReturn a list of named users or look up a single named user by `named_user_id`.Read-only

    List or Look Up Named Users

    Return a list of named users or look up a single named user by `named_user_id`. Returns an object with named_user, ok, named_users, next_page.

    Inputs

    app_keystringrequired
    Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
    idstring
    The `named_user_id` you want to look up. When querying a `named_user_id`, the response contains a single `named_user` object. If you do not query a specific `named_user_id`, the response returns an array of `named_users`, in which each object represents an individual named user. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5