BaxCloud Links SDK for Node.js

Server-side deep link management via BaxLinks — for Express, NestJS, Next.js API routes, and any Node.js backend.

For BaxLinks webhook verification (and other BaxCloud product webhooks), use @baxcloud/baxcloud-server-sdk alongside this package.

Product-specific SDKs:

• @baxcloud/baxstream — docs — video conversion + AI
• @baxcloud/baxmail — docs — transactional email
• @baxcloud/baxverify — docs — SMS OTP verification
• @baxcloud/baxlinks — docs — deep linking & attribution

Installation

npm install @baxcloud/baxlinks

pnpm add @baxcloud/baxlinks

Quick Start

import { BaxCloudLinksClient } from '@baxcloud/baxlinks';

const links = new BaxCloudLinksClient({
  projectId: process.env.BAXCLOUD_PROJECT_ID!,
  apiKey: process.env.BAXCLOUD_API_KEY!,
});

const link = await links.createLink({
  fallbackUrl: 'https://myapp.com/product/123',
  deepLinkPath: '/product/123',
  deepLinkParams: { promo: 'summer' },
  title: 'Summer Sale',
  alias: 'summer-sale',
});

console.log('Short link slug:', link.slug);

Share the link using your project's BaxLinks subdomain or custom domain (configured in Dashboard → BaxLinks → Setup).

API Reference

| Method | Description | |--------|-------------| | createLink(options) | Create a deep link | | listLinks(options?) | List links with pagination | | getLink(linkId) | Get a link by ID | | updateLink(linkId, options) | Update a link | | deleteLink(linkId) | Delete a link | | getStats() | Project-wide link stats | | getAnalytics(linkId) | Click analytics for a link | | getTimeline(linkId, options?) | Click timeline | | uploadImage(linkId, input) | Upload OG preview image |

Error handling

import { BaxLinksError } from '@baxcloud/baxlinks';

try {
  await links.createLink({ fallbackUrl: 'https://example.com' });
} catch (err) {
  if (err instanceof BaxLinksError) {
    console.error(err.statusCode, err.code, err.message);
  }
}

Full reference: baxcloud.tech/docs/links

Examples

See examples/ for referral link and Express samples.

Requirements

• Node.js 18+
• BaxLinks enabled on your BaxCloud project
• API key with Links scope

Related SDKs

• @baxcloud/baxcloud-server-sdk — docs — webhooks, rooms, streaming, PK Battle
• @baxcloud/baxstream — docs — video conversion + AI
• @baxcloud/baxmail — docs — transactional email
• @baxcloud/baxverify — docs — SMS OTP verification

License

MIT

Support

• Help: https://baxcloud.tech/dashboard/help
• Contact: https://baxcloud.tech/contact
• Documentation: https://baxcloud.tech/docs/links/sdk/node
• Email: [email protected]