Quickstart - Automate.ax

Build an HTTP-triggered automation that returns a JSON response.

Before you begin

Create a project directory

mkdir hello-automate
cd hello-automate

bunx automate.ax login

The CLI opens your browser to authorize the device.

Initialize the project

bunx automate.ax init

Select or create a project when prompted. The command installs the package and creates an example automation in automations/example.automation.ts.

Review the automation

The generated example responds to an HTTP request:

automations/example.automation.ts

import { automation, onHttpRequest, respondToHttpRequest } from "automate.ax"

export default automation("Respond to an HTTP request", () => {
  onHttpRequest({
    scope: "automation",
    waitForResponse: true,
  })

  respondToHttpRequest({
    body: JSON.stringify({ message: "Hello from Automate.ax!" }),
    headers: { "content-type": "application/json" },
  })
})

Deploy

bunx automate.ax deploy

The CLI prints the URL for the deployed HTTP trigger.

Invoke the automation

Send a request to the URL printed by the deploy command:

curl YOUR_TRIGGER_URL

The automation responds with:

{ "message": "Hello from Automate.ax!" }

⌘I

​Before you begin

Before you begin