Skip to main content

Installation

Install the SDK using your preferred package manager: npm:
yarn:
pnpm:

Requirements

  • Node.js: 16.0.0 or higher
  • TypeScript: 5.0+ (for TypeScript projects)
  • Fetch API: Native fetch support (Node.js 18+) or polyfill for older versions

Node.js Compatibility

For Node.js versions below 18, you’ll need to install a fetch polyfill:
Then import it before using the SDK:

Features

  • 🚀 TypeScript First - Built with TypeScript, includes comprehensive type definitions
  • 📦 Modern JavaScript - ESM and CommonJS support for maximum compatibility
  • ⚡ Promise-based API - Async/await support using native fetch
  • 🔌 100+ Integrations - Connect to Slack, GitHub, Jira, Linear, and many more
  • 🎯 Unified API - Consistent interface across all integrations via the Unified API
  • 🔑 Proxy API - Direct access to underlying integration APIs
  • 🤖 MCP - Hand a connection to any MCP client, or to OpenAI and Anthropic’s hosted MCP
  • 🪶 Lightweight - Zero dependencies beyond native fetch API
  • 🛡️ Error Handling - Comprehensive error messages and validation
  • 📚 Well Documented - Extensive documentation and examples

Quick Start

Get started with BundleUp in just a few lines of code:

Authentication

The BundleUp SDK uses API keys for authentication. You can obtain your API key from the BundleUp Dashboard.

Getting Your API Key

  1. Sign in to your BundleUp Dashboard
  2. Navigate to API Keys
  3. Click Create API Key
  4. Copy your API key and store it securely

Initializing the SDK

Security Best Practices

  • ✅ DO store API keys in environment variables
  • ✅ DO use a secrets management service in production
  • ✅ DO rotate API keys regularly
  • ❌ DON’T commit API keys to version control
  • ❌ DON’T hardcode API keys in your source code
  • ❌ DON’T share API keys in public channels
Example .env file:
Loading environment variables:

Core Concepts

Auth API

The Auth API runs the hosted authorization flow: build the URL that sends a user to connect an integration, then exchange the one-time code from the redirect for a connection_id. See Authorization Flow.

Platform API

The Platform API provides access to core BundleUp features like managing connections and integrations. Use this API to list, retrieve, and delete connections, as well as discover available integrations.

Proxy API

The Proxy API allows you to make direct HTTP requests to the underlying integration’s API through BundleUp. This is useful when you need access to integration-specific features not covered by the Unified API.

Unified API

The Unified API provides a standardized, normalized interface across different integrations. For example, you can fetch chat channels from Slack or Discord using the same API call.

MCP API

The MCP API reaches a provider’s own MCP server using a connection’s stored credentials. Tools are defined by the provider, not by BundleUp. Because the connection is chosen per client, one agent can serve many end users without ever handling a token. See MCP overview.

API Reference

Connections

Manage your integration connections.

List Connections

Retrieve a list of all connections in your account.
With query parameters:
Query Parameters:
  • integration_id (string): Filter by integration ID
  • integration_identifier (string): Filter by integration identifier (e.g., ‘slack’, ‘github’)
  • external_id (string): Filter by external user/account ID
  • limit (number): Maximum number of results (default: 50, max: 100)
  • offset (number): Number of results to skip for pagination
Response:

Retrieve a Connection

Get details of a specific connection by ID.
Response:

Delete a Connection

Remove a connection from your account.
Note: Deleting a connection will revoke access to the integration and cannot be undone.

Integrations

Discover and work with available integrations.

List Integrations

Get a list of all available integrations.
With query parameters:
Query Parameters:
  • status (string): Filter by status (‘active’, ‘inactive’, ‘beta’)
  • limit (number): Maximum number of results
  • offset (number): Number of results to skip for pagination
Response:

Retrieve an Integration

Get details of a specific integration.
Response:

Webhooks

Manage webhook subscriptions for real-time event notifications.

List Webhooks

Get all registered webhooks.
With pagination:
Response:

Create a Webhook

Register a new webhook endpoint.
Webhook Events:
  • connection.created - Triggered when a new connection is established
  • connection.deleted - Triggered when a connection is removed
  • connection.updated - Triggered when a connection is modified
Request Body:
Response:

Retrieve a Webhook

Get details of a specific webhook.

Update a Webhook

Modify an existing webhook.

Delete a Webhook

Remove a webhook subscription.

Webhook Payload Example

When an event occurs, BundleUp sends a POST request to your webhook URL with the following payload:

Webhook Security

To verify webhook signatures:

Auth API

Connect an end user’s account and get back a connection_id. See Authorization Flow for the full flow.

Build the Authorization URL

The URL needs no API key, so you can also build it where the key must not live, such as in the browser. Import the helper directly:
Parameters:
  • clientId (string, required): Your workspace client ID
  • integrationId (string, required): The integration to connect
  • redirectUri (string, required): Must exactly match a redirect URI registered in your dashboard
  • externalId (string, optional): Your own reference, stored on the connection
  • state (string, optional): Returned unchanged on the redirect

Exchange the Code for a Connection

BundleUp redirects back to redirectUri with a one-time code. Exchange it server-side:
Parameters:
  • code (string, required): The code query parameter from the redirect
  • redirectUri (string, required): The same redirect URI used to build the authorization URL
Response:
The code expires after 5 minutes and can only be exchanged once. An invalid, expired or reused code throws an error that includes the API’s error body.

Proxy API

Make direct HTTP requests to integration APIs through BundleUp.

Creating a Proxy Instance

GET Request

With custom headers:

POST Request

With custom headers:

PUT Request

PATCH Request

DELETE Request

Working with Different Content Types

Sending form data:
Uploading files:

Handling Binary Data

Unified API

Access unified, normalized data across different integrations with a consistent interface.

Creating a Unified API Instance

Chat API

The Chat API provides a unified interface for chat platforms such as Slack and Discord. See Chat.
List Channels
Retrieve a list of channels from the connected chat platform.
Parameters:
  • limit (number, optional): Maximum number of channels to return (default: 100, max: 1000)
  • after (string, optional): Pagination cursor from previous response
  • include_raw (boolean, optional): Include raw API response from the integration (default: false)
Response:
Pagination example:

Git API

The Git API provides a unified interface for version control platforms like GitHub, GitLab, and Bitbucket.
List Repositories
Response:
List Pull Requests
Parameters:
  • repoName (string, required): Repository name in the format ‘owner/repo’
  • limit (number, optional): Maximum number of PRs to return
  • after (string, optional): Pagination cursor
  • include_raw (boolean, optional): Include raw API response
Response:
List Issues
Parameters:
  • repoName (string, required): Repository name in the format ‘owner/repo’
  • limit (number, optional): Maximum number of issues to return
  • after (string, optional): Pagination cursor
  • include_raw (boolean, optional): Include raw API response
Response:
List Tags
Response:
List Releases
Response:
List Commits
branch is optional and accepts a branch name, tag or commit SHA. When it is omitted the provider’s default branch is used. Response:

Tasks API

The Tasks API provides a unified interface for issue trackers and project management tools like Jira, Linear, Asana, Trello, ClickUp, monday.com, Basecamp, Wrike, and Todoist.
List Tasks
Response:
Note: Trello has no endpoint that lists every card, so it returns the cards the connected member is on. To list every card on a board instead, send the board id through the params passthrough parameter as {"board": "5abbe4b7ddc1b351ef961414"}. Trello also returns its collections in a single page, so metadata.next is always null for Trello connections. Filtering and sorting:
List Projects
Response:
Note: Not every platform returns every field. Jira does not expose creation or update timestamps for projects, so created_at and updated_at are null for Jira connections, and status is only set when Jira reports whether the project is archived.

Helpdesk API

The Helpdesk API provides a unified interface for customer support tools like Zendesk, ServiceNow, Zoho Desk, Gorgias, and Help Scout.
List Tickets
Response:
Get a Ticket
Fetch one support ticket by ID. On ServiceNow the ID is the incident’s sys_id.
A single resource carries no pagination, so there is no metadata on this response.

MCP API

Reach a provider’s own MCP server using a connection’s credentials. BundleUp injects and refreshes the access token, so the connection ID is the only thing your agent needs to know about a user. Supported for providers that run a first-party MCP server — see the integrations page. Others return an mcp_not_supported error. BundleUp does not ship an MCP client. Hand hosted() or transport() to the one you already use, or send JSON-RPC yourself with post and delete, which return the response untouched, like the Proxy API.

Creating an MCP Instance

Model-Hosted MCP

OpenAI and Anthropic can connect to an MCP server themselves, with no tool mapping or dispatch loop on your side. Both accept only a single credential and no custom headers, so hosted() returns the server URL alongside the API key and connection joined into one bearer.
Anthropic’s connector takes the same pair as url and authorization_token. server_url must be exactly the URL hosted() returns — the proxy rebuilds the upstream URL from the provider’s own base, so any path or query you append is ignored rather than rejected. This sends your API key to the model provider, whose servers make the request. Use an MCP client in your own backend if that is not acceptable.

Using an MCP Client Library

transport() returns the URL and headers if you would rather use an existing MCP client.

Sending JSON-RPC Directly

MCP requires an initialize handshake before any other method. The session ID comes back on that first response and must be sent on every call after it.
Providers may answer with text/event-stream rather than JSON, so responses need unwrapping either way:
Tool lists can be paginated. If result.nextCursor is set, call tools/list again with params: { cursor: result.nextCursor } until it comes back empty. Calling a tool follows the same shape:

Sessions

MCP sessions live on the provider’s server — BundleUp holds no session state. Close one when you are done:

Errors

BundleUp rejects a request before it reaches the provider by returning an HTTP error with a JSON body — the response is passed straight through, so check response.ok yourself.
Every JSON-RPC message counts toward the rate limit of 100 requests per 60 seconds, per connection — including the initialize handshake.

Several Connections

An agent often needs more than one provider for the same end user. With model-hosted MCP there is nothing to merge — pass one mcp tool per connection and the model provider keeps them apart by server_label:
With an MCP client in your own backend, open one client per connection from its transport(), prefix each tool name with a label (slack__send_message), and route calls back by that prefix. There is no merge helper in the SDK — how tools are namespaced, filtered and recovered from differs enough per agent that it is better written where you can see it. Filter before you hand tools to a model — three providers is easily sixty tools, and accuracy drops as that list grows, so give the agent only the ones it needs.

Error Handling

The SDK throws standard JavaScript errors with descriptive messages. Always wrap SDK calls in try-catch blocks for proper error handling.