> ## Documentation Index
> Fetch the complete documentation index at: https://docs.swisstools.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Your First Mock Endpoint Running in Swisstools

> Sign up, create a project, and have a working mock API endpoint or webhook inbox URL ready to use in under a minute.

This guide walks you through signing up for Swisstools and setting up your first mock endpoint or webhook inbox. By the end, you'll have a live URL you can point your application at.

<Steps>
  <Step title="Create your account">
    Go to [swisstools.dev](https://swisstools.dev) and click **Get Started**. You can register with an email and password, or sign in with your GitHub or Google account.

    Once you complete registration, you're taken to the dashboard.
  </Step>

  <Step title="Find your personal team">
    Swisstools automatically creates a personal team for you on signup — you don't need to do anything. Your personal team appears in the team selector on the dashboard and is where you'll create your first project.

    <Note>
      Your team has a short internal reference ID (distinct from its display name) that appears as part of your project subdomain URLs. You'll see this in action in the next steps.
    </Note>
  </Step>

  <Step title="Create your first project">
    On the dashboard, click **New Project**. Give it a name and a slug. The slug becomes part of your project's subdomain:

    ```
    <team_ref>-<project_slug>.swisstools.dev
    ```

    For example, if your team ref is `a1b2c3d4` and your project slug is `payments-api`, your project URL base is:

    ```
    https://a1b2c3d4-payments-api.swisstools.dev
    ```

    The name auto-generates a slug as you type, but you can edit it manually. Click **Create** to continue.
  </Step>

  <Step title="Add a mock endpoint or a webhook inbox">
    From your project page, navigate to either **Mocks** or **Webhooks** in the sidebar.

    **To create a mock endpoint:**

    Click **New Mock** and configure:

    * **Method** — `GET`, `POST`, `PUT`, `DELETE`, etc.
    * **Endpoint path** — e.g. `/users` or `/orders/:id`
    * **Status code** — e.g. `200`
    * **Response headers** — key/value pairs returned with the response
    * **Response body** — the JSON (or any text) your mock returns

    Your mock is live immediately after saving. No restart needed.

    **To create a webhook inbox:**

    Click **New Webhook**, give it a name and optional description, then save. Swisstools generates a unique webhook ID for it.
  </Step>

  <Step title="Copy your URL and use it in your app">
    **Mock endpoint URL format:**

    ```bash theme={null}
    https://<team_ref>-<project_slug>.swisstools.dev/api/mock/<endpoint_path>
    ```

    For example, if you created a `GET /users` mock:

    ```bash theme={null}
    curl https://myteam-myproject.swisstools.dev/api/mock/users
    ```

    **Webhook inbox URL format:**

    ```
    https://<team_ref>-<project_slug>.swisstools.dev/api/webhook/<webhook_id>
    ```

    Point any service at this URL to start capturing requests. Open the webhook detail page in Swisstools and watch incoming requests appear in real time via the live stream.

    <Tip>
      The webhook inbox streams new requests over WebSocket as they arrive — you don't need to refresh the page. The full request details (method, headers, query params, and body) are shown for each captured request. Requests are stored for 12 hours, up to 50 per inbox.
    </Tip>
  </Step>
</Steps>

## What's next

Now that your first project is up and running, explore the rest of what Swisstools offers:

<CardGroup cols={2}>
  <Card title="API Mocking" icon="globe" href="/api-mocking/overview">
    Learn how to configure mock responses, set custom headers, and manage multiple endpoints per project.
  </Card>

  <Card title="Webhook Inbox" icon="bolt" href="/webhooks/overview">
    Understand how to inspect captured requests and use webhook data during development and testing.
  </Card>

  <Card title="Feature Flags" icon="flag" href="/feature-flags/overview">
    Set up flags, create groups with percentage-based rollouts, and access them via API key from your app.
  </Card>

  <Card title="Release Notes" icon="sparkles" href="/releases/overview">
    Connect a GitHub repository and generate AI-drafted release notes from your commit history.
  </Card>
</CardGroup>
