Skip to main content
Most of this CLI is generated. Commands, flags, help text and validation all come from the tool catalog that also defines what a connected agent can do — so the console, your agent and your terminal are one API, and a new capability appears in all three at once rather than in whichever one someone remembered. Which is also why this page is worth trusting: it is produced from that catalog rather than written alongside it.

Reading it

Every command has its own help, the hand-written ones included: hookie replay --help shows --since, --failed, --destination and --limit with an example, and hookie login --help shows --scope, --no-open, --name and --reregister.
  • * marks a required flag.
  • ⚠️ marks a command that asks before acting. That gate reads the tool catalog, never the word “delete”. hookie workflows delete only deactivates, and an update undoes it, so it asks only with --permanent. hookie keys revoke destroys a credential and has no “delete” in its name.
  • A flag name is the API field in kebab case, so webhook_id is --webhook-id. Where two sibling routes spell the same field differently — create takes datasetFilter, update takes dataset_filter — the flag is the same on both and the CLI sends whichever spelling that route wants.
  • An unknown flag is an error, with a suggestion. --datset orders would otherwise be a successful call that quietly did the wrong thing.
Every command also takes the global flags: --url, --project, --json, --reveal, --redact, --yes, --quiet.
--project takes a slug or an id, and with neither it uses your workspace’s Default project. There is deliberately no --project-id: two ways to say the same thing, one of which silently 404s on a slug, is worse than one.

Hand-written commands

These are not single API calls, so they are not generated. Operations covers them in full.

Generated commands

ai-agents

Named model configurations a workflow’s agent_call step runs by id. update changes only the flags you pass.

cron-triggers

Owner/admin in the console, so a connected agent needs hookie:manage. --payload is JSON; {{now}} in it becomes the fire time.

datasets

deliveries

destinations

endpoints

events

held-deliveries

Deliveries held because the workspace used its monthly delivery allowance. hookie held_deliveries still works as an alias.

keys

members

Read-only, at hookie:read. Inviting, changing roles and removing people are for a person in the console: see Team members.

portal-tokens

Customer links to the project’s portal. create returns the token once; --reveal prints it.

portals

The project’s one customer portal. update creates it the first time.

project-config

The same document hookie export writes, as JSON. import takes it with --config @file.json.

projects

records

rules

sources

Database sources: Hookie polls a Postgres table and files each new row as a record. --config is JSON, {"url":"postgres://…","table":"public.orders"} or @source.json; it holds the database credentials, is encrypted at rest and is never printed back. --cursor-column is required: a column that only grows, such as an id or created_at, so each poll takes only new rows.

submissions

triggers

AI triggers.

views

workflows

workspace

ws-triggers

Owner/admin in the console, so a connected agent needs hookie:manage. --headers may carry the socket’s credential; it is encrypted and never printed back.

Two that are narrower than they look

hookie workflows update is a full replace, not a patch — which is why --name, --entry-dataset and --steps are all required. Omitting one would drop it. Read the current definition first:
hookie endpoints update changes an endpoint’s name, dataset, enabled state, IP allowlist, form redirect, allowed origins and URL verification, but never its slug, criteria or mappings. The slug is part of the credential in its public URL, and the criteria and mappings define what it has already ingested — changing those in place would quietly reinterpret history. To change them, publish a new version with hookie endpoints version. hookie rules update, by contrast, changes any field of a rule, conditions and mappings included, and sends only the flags you pass. Try a rule before you save it in the console’s rule editor, or with POST /admin/api/projects/{project_id}/rules/test.

JSON flags

A flag whose value is a list or an object takes JSON, or @file.json to read it from disk — which is how a workflow’s steps get past your shell’s quoting:
A Slack or S3 destination’s --config holds a credential, so read it from a file rather than typing it, where it would land in your shell history:
A list of plain strings also takes a comma-separated list, because '["orders","shipments"]' is a quoting puzzle with no upside: