Documentation — Archway

🚀

Quick Start

Create and deploy your first bridge in under a minute.

🔌

API Reference

Full REST API documentation for bridges, secrets, and invocations.

💬

Knowledge Base

Browse guides and FAQs on Intercom.

Quick Start

Your first bridge

Sign up
Create an account at app.tryarchway.ai. No credit card required for the Free plan.
Create a bridge
Click "New Bridge" from the dashboard. Give it a name and optional description.
Write your code
Use the built-in editor. Your bridge exports a default async handler function that receives req and ctx parameters.
Add secrets (optional)
If your bridge needs API keys, ask your customer to provide them through the Customer Portal. Reference them with ctx.secret("NAME").
Deploy
Click "Deploy". Your bridge gets a unique URL and is immediately callable.
Monitor
View invocation logs, status codes, and response times from the bridge detail page.

API Reference

REST API overview

Method	Endpoint	Description
GET	/api/bridges	List all bridges
POST	/api/bridges	Create a new bridge
GET	/api/bridges/:id	Get bridge details
PATCH	/api/bridges/:id	Update a bridge
DELETE	/api/bridges/:id	Delete a bridge
POST	/api/bridges/:id/deploy	Deploy a bridge
GET	/api/bridges/:id/invocations	List invocations
GET	/api/secrets	List secrets (names only)
POST	/api/secrets	Create a secret
GET	/api/customers	List customers

Example: Create a bridge

// POST /api/bridges
const response = await fetch(https://app.tryarchway.ai/api/bridges, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${token}`
  },
  body: JSON.stringify({
    name: "CRM Sync",
    description: "Syncs contacts from Salesforce",
    code: `export default async function handler(req, ctx) { ... }`
  })
});

Bridge handler signature

export default async function handler(
  req: {
    method: string;
    headers: Record<string, string>;
    body: any;
    query: Record<string, string>;
  },
  ctx: {
    secret(name: string): string;
    bridgeId: string;
    customerId: string;
  }
)

Learn Archway

Quick Start

API Reference

Knowledge Base

Your first bridge

REST API overview

Example: Create a bridge

Bridge handler signature

Need help?