Skip to main content

​
Tutorial: First automation (web Quickstart)

This walkthrough matches the Quickstart Integration area in the web dashboard. You will end with an Agent ID, optionally a workspace API key, and a path to n8n, Zapier, or a custom HTTP client.

​
Prerequisites

  • Access to the web dashboard for your deployment, signed in as a workspace owner (API key generation requires owner).
  • Your deployment’s Agent API base URL (for example https://api.example.com without a trailing slash). The Quickstart surfaces this from dashboard configuration where available.

​
Steps

​
1. Agent

  1. Open Quickstart Integration in the sidebar.
  2. In Agent, either select an existing agent or create one and copy its Agent ID (UUID).
You will send this value on every automation request as the X-Agent-Id header.

​
2. API key (optional but typical)

  1. Move to the API key step.
  2. Optionally generate a workspace API key with a label you recognize.
Only owners can create keys. The plaintext secret is shown once—copy it to a password manager or your tool’s secret store. Use it as the X-Api-Key header. If you skip key creation, you must already have a valid workspace key from elsewhere.

​
3. Integration

  1. Choose n8n, Zapier, or custom.
  2. Follow the on-screen snippets: they align with n8n, Zapier, and the Agent API for custom HTTP.

​
Verify

Send a test POST /v1/approvals with your headers (you may omit request_id; the response includes one). Resolve the approval in the dashboard or mobile app, then confirm the result via callback or polling as described in How it works.