Outpost TypeScript SDK

Developer-friendly & type-safe Typescript SDK specifically catered to leverage the Outpost API.

Summary

Outpost API: The Outpost API is a REST-based JSON API for managing tenants, destinations, and publishing events.

Table of Contents

• Outpost TypeScript SDK
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Global Parameters
  • Pagination
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @hookdeck/outpost-sdk

PNPM

pnpm add @hookdeck/outpost-sdk

Bun

bun add @hookdeck/outpost-sdk

Yarn

yarn add @hookdeck/outpost-sdk

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Outpost": {
      "command": "npx",
      "args": [
        "-y", "--package", "@hookdeck/outpost-sdk",
        "--",
        "mcp", "start",
        "--admin-api-key", "...",
        "--tenant-jwt", "...",
        "--tenant-id", "..."
      ]
    }
  }
}

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Outpost": {
      "command": "npx",
      "args": [
        "-y", "--package", "@hookdeck/outpost-sdk",
        "--",
        "mcp", "start",
        "--admin-api-key", "...",
        "--tenant-jwt", "...",
        "--tenant-id", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @hookdeck/outpost-sdk -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost();

async function run() {
  const result = await outpost.health.check();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | | ------------- | ---- | ----------- | | adminApiKey | http | HTTP Bearer | | tenantJwt | http | HTTP Bearer |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost({
  security: {
    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await outpost.health.check();

  console.log(result);
}

run();

Available Resources and Operations

destinations

• list - List Destinations
• create - Create Destination
• get - Get Destination
• update - Update Destination
• delete - Delete Destination
• enable - Enable Destination
• disable - Disable Destination

events

• list - List Events
• get - Get Event
• listDeliveries - List Event Delivery Attempts
• listByDestination - List Events by Destination
• getByDestination - Get Event by Destination
• retry - Retry Event Delivery

health

• check - Health Check

publish

• event - Publish Event

schemas

• listTenantDestinationTypes - List Destination Type Schemas (for Tenant)
• get - Get Destination Type Schema (for Tenant)
• listDestinationTypesJwt - List Destination Type Schemas (JWT Auth)
• getDestinationTypeJwt - Get Destination Type Schema

tenants

• upsert - Create or Update Tenant
• get - Get Tenant
• delete - Delete Tenant
• getPortalUrl - Get Portal Redirect URL
• getToken - Get Tenant JWT Token

topics

• list - List Available Topics (for Tenant)
• listJwt - List Available Topics)

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• destinationsCreate - Create Destination
• destinationsDelete - Delete Destination
• destinationsDisable - Disable Destination
• destinationsEnable - Enable Destination
• destinationsGet - Get Destination
• destinationsList - List Destinations
• destinationsUpdate - Update Destination
• eventsGet - Get Event
• eventsGetByDestination - Get Event by Destination
• eventsList - List Events
• eventsListByDestination - List Events by Destination
• eventsListDeliveries - List Event Delivery Attempts
• eventsRetry - Retry Event Delivery
• healthCheck - Health Check
• publishEvent - Publish Event
• schemasGet - Get Destination Type Schema (for Tenant)
• schemasGetDestinationTypeJwt - Get Destination Type Schema
• schemasListDestinationTypesJwt - List Destination Type Schemas (JWT Auth)
• schemasListTenantDestinationTypes - List Destination Type Schemas (for Tenant)
• tenantsDelete - Delete Tenant
• tenantsGet - Get Tenant
• tenantsGetPortalUrl - Get Portal Redirect URL
• tenantsGetToken - Get Tenant JWT Token
• tenantsUpsert - Create or Update Tenant
• topicsList - List Available Topics (for Tenant)
• topicsListJwt - List Available Topics)

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set tenant_id to "<id>" at SDK initialization and then you do not have to pass the same value on calls to operations like upsert. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available.

| Name | Type | Description | | -------- | ------ | ----------------------- | | tenantId | string | The tenantId parameter. |

Example

import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost({
  tenantId: "<id>",
  security: {
    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await outpost.tenants.upsert({});

  console.log(result);
}

run();

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost({
  tenantId: "<id>",
  security: {
    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await outpost.events.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost();

async function run() {
  const result = await outpost.health.check({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await outpost.health.check();

  console.log(result);
}

run();

Error Handling

OutpostError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Outpost } from "@hookdeck/outpost-sdk";
import * as errors from "@hookdeck/outpost-sdk/models/errors";

const outpost = new Outpost();

async function run() {
  try {
    const result = await outpost.health.check();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.OutpostError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.NotFoundError) {
        console.log(error.data$.message); // string
        console.log(error.data$.additionalProperties); // { [k: string]: any }
      }
    }
  }
}

run();

Error Classes

Primary errors:

• OutpostError: The base class for HTTP error responses.
  • BadRequestError: A collection of codes that generally means the end user got something wrong in making the request.
  • UnauthorizedError: A collection of codes that generally means the client was not authenticated correctly for the request they want to make.
  • NotFoundError: Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing.
  • TimeoutError: Timeouts occurred with the request.
  • RateLimitedError: Status codes relating to the client being rate limited by the server. Status code 429.
  • InternalServerError: A collection of status codes that generally mean the server failed in an unexpected way.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from OutpostError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost({
  serverURL: "http://localhost:3333/api/v1",
});

async function run() {
  const result = await outpost.health.check();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Outpost } from "@hookdeck/outpost-sdk";
import { HTTPClient } from "@hookdeck/outpost-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Outpost({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Outpost } from "@hookdeck/outpost-sdk";

const sdk = new Outpost({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy