DocsGetting StartedQuickstart

Quickstart

Get up and running with Forge in under 5 minutes. Install the SDK, configure your API key, and make your first request.

Install & configure

Install the Forge SDK from npm and set your API key as an environment variable. You can find your key in the Dashboard → API Keys section.

terminal

bash

# Install the SDK
npm install @forge/sdk

# Set your API key
export FORGE_API_KEY=nxs_live_aBcDeFgH...

# Make your first request
npx forge ping

Make your first request

Use the SDK to list your API keys and create a webhook. All methods return typed responses with full IntelliSense support.

index.ts

typescript

import { Forge } from "@forge/sdk";

const forge = new Forge({
  apiKey: process.env.FORGE_API_KEY,
});

// List all API keys
const keys = await forge.keys.list();

// Create a new webhook
const webhook = await forge.webhooks.create({
  url: "https://example.com/webhook",
  events: ["api.request", "key.rotated"],
});

console.log(webhook.id); // whk_aBcDeFgH...

Handle the response

Every API response follows a consistent structure. Resources include timestamps, unique IDs, and related metadata.

response.json

json

{
  "id": "whk_aBcDeFgH",
  "url": "https://example.com/webhook",
  "events": ["api.request", "key.rotated"],
  "status": "active",
  "created_at": "2025-01-15T09:30:00Z",
  "signing_secret": "whsec_..."
}

Popular guides

Common workflows and integrations

Tutorial

Build a webhook consumer in 5 minutes

Guide

Migrating from REST to GraphQL API

Tutorial

Using the API Playground

Reference

Rate limiting & retry strategies

Next steps

Explore the full API Reference for every endpoint and parameter
Set up Webhooks to receive real-time events
Configure OAuth 2.0 for user-level authentication
Browse SDK documentation for your preferred language