Router.so

https://docs.router.so
Admin
Router.so is an open-source headless form handling and lead routing solution for developers,...
Tokens:1,022
Snippets:9
Trust Score:6.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Node.js Dependencies

Source: https://docs.router.so/open-source/self-hosting

Installs all required Node.js packages and project dependencies listed in the package.json file, ensuring all necessary libraries are available for the application to run.

```bash
npm install
```

--------------------------------

### Start Development Server

Source: https://docs.router.so/open-source/self-hosting

Initiates the Router.so application in development mode. This typically starts a local server, enabling hot-reloading and other development-specific features for easier testing and debugging.

```bash
npm run dev
```

--------------------------------

### Router.so Create Lead API Endpoint Documentation

Source: https://docs.router.so/api-reference/endpoint/create

Comprehensive documentation for the Router.so API endpoint used to create new leads. It details the HTTP method, URL structure, required authentication, path parameters, request body schema, and the structure of the successful response, including cURL usage and JSON response examples.

```APIDOC
POST /api/endpoints/{endpointId}
  - Description: Create a new lead for a specific endpoint.

  Authentication:
    - Authorization: string (required)
      - Description: Your API key. Include this in the request header as `Authorization: Bearer YOUR_API_KEY`.

  Path Parameters:
    - endpointId: string (required)
      - Description: The unique identifier for the user’s endpoint.

  Request Body:
    - name: string (required)
      - Description: The name of the lead.
      - Example: {"name": "John Doe"}

  Response:
    - id: string
      - Description: The unique identifier for the created lead.
    - name: string
      - Description: The name of the lead.
    - createdAt: string (ISO 8601 format)
      - Description: The timestamp of when the lead was created.
      - Example: {
          "id": "lead_123456",
          "name": "John Doe",
          "createdAt": "2023-04-01T12:00:00Z"
        }

  Usage Example (cURL):
    curl -X POST https://app.router.so/api/endpoints/{endpointId} \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"name": "John Doe"}'
```

--------------------------------

### Router.so Endpoint Details URL Pattern

Source: https://docs.router.so/forms/endpoints

This snippet provides the URL pattern to access the detailed page for a specific endpoint within the Router.so dashboard. This page includes usage examples for integrating the endpoint with basic HTML forms, JavaScript fetch calls, and React forms styled with shadcn/ui.

```Text
app.router.so/endpoints/{your-endpoint-id}
```

--------------------------------

### Clone Router.so Repository

Source: https://docs.router.so/open-source/self-hosting

Clones the Router.so GitHub repository to your local machine and navigates into the main project directory, which is the first step in setting up the application locally.

```bash
git clone https://github.com/9d8dev/router.git
cd router/main
```

--------------------------------

### Generate Database Migrations with Drizzle Kit

Source: https://docs.router.so/open-source/self-hosting

Executes the Drizzle Kit command to generate new database migration files based on the current schema definitions. This prepares the database for any structural changes or updates.

```bash
npm drizzle-kit generate
```

--------------------------------

### Run Database Migrations

Source: https://docs.router.so/open-source/self-hosting

Applies the generated database migration files to the PostgreSQL database. This command updates the database schema to match the application's current data model.

```bash
npm tsx lib/db/migrate.ts
```

--------------------------------

### Create Lead API Endpoint Reference

Source: https://docs.router.so/api-reference/introduction

Documents the primary API endpoint for creating new leads. This POST endpoint allows users to submit form data to a specific endpoint ID, facilitating lead capture within Router.so.

```APIDOC
POST /api/endpoints/{endpointId}
  - Description: Creates a new lead for a specific endpoint ID.
  - Parameters:
    - {endpointId}: The unique identifier of the endpoint to which the lead will be submitted. (Type: string, Path Parameter)
  - Returns: (Details not provided in source text)
  - Request Body: (Details not provided in source text)
```

--------------------------------

### API Authentication with Bearer Token

Source: https://docs.router.so/api-reference/introduction

Illustrates how to authenticate API requests by including a Bearer token in the Authorization header. This method ensures secure access to Router.so API endpoints.

```bash
Authorization: Bearer YOUR\_API\_KEY
```
Tokens:
Raw