Auxx Documentation

Build your first Auxx app — from scaffolding to seeing it run inside the platform.

Create a developer account

Head over to the Developer Dashboard and sign in with your Auxx account.

Create a developer account. Set the name to your company or organization name.

Create a new app

From the dashboard, create a new app. Fill in the app name and ensure it has a unique slug.

The slug is used as your project identifier and cannot be changed later.

Initialize your app

Open your terminal and run:

auxx init my-first-app

This scaffolds a new project from the Auxx app template with everything you need to get started.

Your app slug can be found on the app details page in the Developer Dashboard.

Install dependencies

Navigate into the project folder and install dependencies:

cd my-first-app
npm install

Log in to the CLI

Authenticate the CLI with your developer account:

auxx login

Verify you're logged in:

auxx whoami

Start the development server

Start your app in development mode:

auxx dev

The CLI will ask you to choose a workspace. Once selected, you'll be redirected to install the app.

We recommend creating a separate workspace for development rather than using your production workspace.

Install your app

Follow the CLI prompt to install your app in the chosen workspace. This makes your app's actions, widgets, and workflow blocks available inside Auxx.

Try out your app

Head to any ticket record in Auxx. Click the actions menu — you should see your app's "Hello World" action listed.

Click it to open a dialog rendered by your app.

Congratulations — your app is running inside Auxx!

Make changes

Open src/hello-world-dialog.tsx in your editor. Try changing the text or adding a new component:

src/hello-world-dialog.tsx

import { TextBlock, Button, Badge, Separator } from '@auxx/sdk/client'

export function HelloWorldDialog({ recordId, hideDialog }) {
  return (
    <>
      <TextBlock align="left">Record: {recordId}</TextBlock>
      <Badge>Live</Badge>
      <Separator />
      <Button label="Close" onClick={hideDialog} />
    </>
  )
}

Save the file, then close and re-open the dialog in Auxx. Your changes appear immediately.

Explore the project structure

Here's what the template includes:

app.tsx

app.settings.ts

hello-world-action.tsx

hello-world-dialog.tsx

contact-form-action.tsx

send-email.workflow.tsx

send-email.server.ts

package.json

tsconfig.json

Key files:

app.tsx — Main entry point. Exports the app config object and App component.
app.settings.ts — Settings schema (auto-generates UI in the platform).
*.server.ts — Server-only code (runs in Lambda, not the browser).
*.workflow.tsx — Custom workflow blocks.
events/*.event.ts — Connection lifecycle handlers.
webhooks/*.webhook.ts — Incoming webhook handlers.