Every hookie command, generated from the same tool catalog the CLI builds itself from.
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
hookie <group> <verb> [flags]hookie <group> # means <group> listhookie <group> --help # the group's commandshookie <group> <verb> --help # usage, the flags with their types and which are required, and an examplehookie help <group> <verb> # the same
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.
Command
hookie login · logout · whoami · status
Connect this machine, and see what it is connected to.
Create a cron trigger: on its schedule it emits payload as an event, filed into dataset if given or routed by the project’s rules if not (a run no rule matches is stored whole, as one record, in default), and fanned out like any other event.
Change a cron trigger in place: pause or resume it, rename it, or change its schedule, time zone, payload or dataset. With no dataset, a run no rule matches is stored whole, as one record, in default.
hookie cron-triggers test
--cron-trigger-id*
Fire a cron trigger once, now.
hookie cron-triggers delete ⚠️
--cron-trigger-id*
Delete a cron trigger.
datasets
Command
Flags
hookie datasets list
—
The datasets in a project, with per-dataset record counts.
hookie datasets query
--dataset* --view --limit --offset
One page of a dataset’s records (25 by default), newest first; --view shapes it through a saved view, and total says how many there are in all.
deliveries
Command
Flags
hookie deliveries list
—
Recent outbound deliveries for a project — status, response code, destination.
hookie deliveries get
--delivery-id*
One delivery in full: its latest response body and every attempt it made.
hookie deliveries metrics
--window --destination-id
Delivery health per destination: success rate, p50/p95/p99 latency, failed attempts by class, and a time series.
Create an outbound destination. --type is webhook (the default), which needs --url, or slack or s3, which take --config instead and no --url, --headers or --auth. Optionally with custom headers, authentication, a body template and an alert URL (see Destination types and options).
Rename a destination, move it to a new https URL or change a Slack or S3 destination’s --config (settings left out keep their stored values), enable or disable it (enabling one Hookie switched off for failing clears its failure streak and sends what it held), change which datasets it receives, set its headers, authentication, body template or alert URL, or set its delivery limits: a request timeout, a maximum send rate and a concurrency cap (null restores the default: 10 s, unlimited, unlimited).
hookie destinations delete ⚠️
--destination-id*
Delete a destination.
endpoints
Command
Flags
hookie endpoints list
—
A project’s endpoints.
hookie endpoints activity
--webhook-id* --kind --limit --offset
One endpoint’s received and refused requests over the last 7 days, and why each was refused.
Create an endpoint. --slug and --dataset are optional: the slug is made from the name, and the dataset is the name as an identifier, or default. --verification turns on provider signature verification.
Change an endpoint in place: enable or disable it, rename it, re-point its dataset, or set its IP allowlist, form redirect, allowed browser origins, URL verification or provider signature verification. Pass at least one.
hookie endpoints rotate
--webhook-id* --overlap-hours
Give an endpoint a new URL; the old one keeps working for the overlap (default 24 hours).
hookie endpoints rotate-secret
--webhook-id* --secret* --overlap-hours
Replace the provider signing secret an endpoint verifies with, when the provider rolls it; the old secret keeps verifying for the overlap (default 24 hours, 0 ends it at once).
Publish a new version of an endpoint with different criteria, mappings or dataset, leaving the old version and its URL working so senders can move over.
events
Command
Flags
hookie events search
--q --dataset --since --until --limit --offset
Search stored records across datasets, with a free-text term, a dataset filter, a time window and paging.
held-deliveries
Deliveries held because the workspace used its monthly delivery allowance. hookie held_deliveries still works as an alias.
Command
Flags
hookie held-deliveries list
—
Events whose deliveries are held because the workspace used its monthly delivery allowance, oldest first, with the allowance used this month. Held deliveries are not lost.
hookie held-deliveries release
—
Send held deliveries, oldest first, while the monthly delivery allowance covers them (after the 1st UTC or an upgrade). Stops at the first event it cannot fully cover.
keys
Command
Flags
hookie keys list
—
This project’s ingest keys, metadata only — never the full token.
Create an ingest key. Returns the plaintext once; --reveal prints it. --dataset-default names the dataset an event sent with no dataset in the URL is stored in when no rule matches it (default if left out).
hookie keys update
--key-id* --name --expires-at --ip-allowlist
Rename a key, or set or clear its expiry or IP allowlist.
hookie keys rotate
--key-id* --overlap-hours --expires-at
Issue a replacement key; the old one keeps working for the overlap (default 24 hours). Returns the new key once; --reveal prints it.
hookie keys revoke ⚠️
--key-id*
Revoke an ingest key.
members
Read-only, at hookie:read. Inviting, changing roles and removing people are for a person in the console: see Team members.
Command
Flags
hookie members list
—
The people in the current workspace: user_id, email, name, role (owner, admin, developer or viewer) and joined_at, owner first. Also max_members, the plan’s member limit (null: unlimited).
portal-tokens
Customer links to the project’s portal. create returns the token once; --reveal prints it.
Command
Flags
hookie portal-tokens list
--portal-id*
The access links issued for a customer portal: customer_id, token_prefix, expires_at, revoked_at.
hookie portal-tokens create
--portal-id* --customer-id* --expires-in-days
Issue a customer an access link to the portal.
hookie portal-tokens revoke ⚠️
--portal-id* --token-id*
Revoke a customer’s portal link.
portals
The project’s one customer portal. update creates it the first time.
Command
Flags
hookie portals get
—
This project’s customer portal, or null if it has none: its id, name, the datasets it exposes (event_types) and whether it is enabled.
hookie portals update
--name --event-types --enabled
Create this project’s customer portal, or change it: its name, the datasets it exposes, and whether it is enabled.
hookie portals delete
--portal-id*
Switch this project’s customer portal off: every customer link stops working.
project-config
The same document hookie export writes, as JSON. import takes it with --config @file.json.
Command
Flags
hookie project-config export
—
A project’s configuration as one document (the hookie.yml shape): endpoints, rules, destinations, AI agents, workflows, AI triggers, cron triggers and record views. Nothing secret is in it.
hookie project-config import
--config*
Create in a project what an exported document describes. Each resource is created through its own route with new endpoint URLs and signing secrets; anything that already exists is skipped, never overwritten.
projects
Command
Flags
hookie projects list
—
List the projects in the workspace.
hookie projects get
—
A project’s details plus its dataset summary.
hookie projects create
--name* --type
Create a project.
records
Command
Flags
hookie records get
--record-id*
One record in full, including fields no view selected.
hookie records delete ⚠️
--record-id*
Permanently delete one stored record and every copy of it: its raw submission, its deliveries (replays included) and their response bodies, held deliveries, the workflow runs it started, and AI trigger output derived from it. Cannot be undone; see Delete, export and close.
Change a mapping rule in place: enable or disable it, rename it, point it at another dataset, or replace its conditions or mappings. Send only what changes.
hookie rules delete ⚠️
--rule-id*
Delete a mapping rule.
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.
Command
Flags
hookie sources list
—
This project’s source connectors (polled databases and HTTP endpoints), with their last run and last error.
Connect a database source: Hookie polls a Postgres table and files each new row into dataset as a record, which then fans out to destinations, triggers and workflows like any event.
hookie sources update
--source-id* --enabled*
Pause or resume a database source.
hookie sources test
--source-id*
Check that a database source can connect and read its table, without storing anything.
hookie sources delete ⚠️
--source-id*
Delete a database source.
submissions
Command
Flags
hookie submissions search
--q --since --until --limit --offset
Search raw submissions — the body exactly as it arrived, before any rule reshaped it.
triggers
AI triggers.
Command
Flags
hookie triggers list
—
This project’s AI triggers — what each one matches and what it does when it fires.
Create an AI trigger: every record that lands in dataset and meets conditions runs the model with instructions over it, and the reply is stored as a record in output_dataset.
hookie triggers update
--trigger-id* --enabled*
Enable or disable an AI trigger.
hookie triggers delete ⚠️
--trigger-id*
Delete an AI trigger.
views
Command
Flags
hookie views list
--dataset
The saved table views for a project, or for one dataset.
Save a table view for a dataset. A column or sort key can be a dotted path into a nested field, such as customer.email; a field literally named that wins.
hookie views delete ⚠️
--view-id*
Delete a saved table view.
workflows
Command
Flags
hookie workflows list
—
Workflow definitions in a project.
hookie workflows get
--workflow-id*
One workflow definition in full: entry dataset, entry conditions and every step.
Deactivate a workflow; an update with --active turns it back on. ⚠️ With --permanent, delete it and its run history for good (refused while a run has not finished).
hookie workflows cancel
--instance-id*
Cancel a running or waiting workflow instance. A finished one answers 409.
hookie workflows retry
--instance-id*
Retry a failed, timed-out or (Cloudflare engine) cancelled workflow instance.
workspace
Command
Flags
hookie workspace get
—
The current workspace: its slug, id, your role and plan.
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.
Command
Flags
hookie ws-triggers list
—
This project’s WebSocket triggers: name, conditions, mappings, dataset, connection status and last error.
Create a WebSocket trigger: Hookie holds an outbound connection to url and turns each frame that meets conditions into an event, filed into dataset or routed by the project’s rules (a frame no rule matches is stored whole, as one record, in default). --mappings reshape each frame the way a rule’s do; with none, the frame is kept as it arrived.
hookie ws-triggers update
--ws-trigger-id* --enabled*
Connect or disconnect a WebSocket trigger.
hookie ws-triggers test
--ws-trigger-id*
Open a short-lived connection with a WebSocket trigger’s settings and return the first frames, without storing anything.
hookie ws-triggers delete ⚠️
--ws-trigger-id*
Delete a WebSocket trigger.
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 list of plain strings also takes a comma-separated list, because '["orders","shipments"]' is a quoting puzzle with no upside:
hookie destinations create --name Warehouse --url https://wh.internal/h --dataset-filter orders,shipmentshookie destinations update --destination-id d_1 --dataset-filter null # null means all datasets
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hookie","description":"Capture, route and deliver webhooks on Cloudflare — ingest anything, route it into datasets with rules, and deliver signed events with retries, AI triggers and multi-step workflows.","colors":{"primary":"#2B56A1","light":"#749ADC","dark":"#2CB8B8"},"logo":{"light":"https://mintcdn.com/hookie-ai/3zmwtACPzz3wb-OX/logo/light.svg?fit=max\u0026auto=format\u0026n=3zmwtACPzz3wb-OX\u0026q=85\u0026s=3d05bb847a5407bc7e75e7270aafc101","dark":"https://mintcdn.com/hookie-ai/3zmwtACPzz3wb-OX/logo/dark.svg?fit=max\u0026auto=format\u0026n=3zmwtACPzz3wb-OX\u0026q=85\u0026s=3a34a943f368167074930496ba10fa63","href":"https://hookie.ai"},"favicon":"https://mintcdn.com/hookie-ai/3zmwtACPzz3wb-OX/favicon.svg?fit=max\u0026auto=format\u0026n=3zmwtACPzz3wb-OX\u0026q=85\u0026s=e81ffa68ca681fd9823d22e0e57d7003","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","python"]}},"navbar":{"links":[{"href":"https://hookie.ai","label":"Hookie.ai"},{"href":"https://hookie.ai/use-cases","label":"Use cases"},{"href":"https://hookie.ai/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Open console","href":"https://app.hookie.ai/"}},"footer":{"socials":{"website":"https://hookie.ai"},"links":[{"header":"Product","items":[{"label":"Features","href":"https://hookie.ai/features"},{"label":"Use cases","href":"https://hookie.ai/use-cases"},{"label":"Pricing","href":"https://hookie.ai/pricing"},{"label":"Changelog","href":"https://hookie.ai/changelog"},{"label":"Status","href":"https://hookie.ai/status"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"API reference","href":"/api-reference"},{"label":"Connected agents","href":"/connected-agents"}]},{"header":"Company","items":[{"label":"Security","href":"https://hookie.ai/security"},{"label":"Contact","href":"https://hookie.ai/contact"}]},{"header":"Legal","items":[{"label":"Terms","href":"https://hookie.ai/legal/terms"},{"label":"Privacy","href":"https://hookie.ai/legal/privacy"},{"label":"Acceptable use","href":"https://hookie.ai/legal/acceptable-use"}]}]},"styling":{"codeblocks":"dark","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hookie-ai","hasAudioNarration":false,"actualSubdomain":"hookie-ai","customDomains":["docs.hookie.ai"],"gitSource":{"type":"github","owner":"bcusack1996","repo":"hookie-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afd13d8ac8f7eaa1aaa19bf","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":312},{"language":"default","tag":"Data workspace","count":53},{"language":"default","tag":"Workspace","count":26},{"language":"default","tag":"Guides","count":23},{"language":"default","tag":"Knowledge graph","count":23},{"language":"default","tag":"Customer Portal","count":18},{"language":"default","tag":"Portals","count":12},{"language":"default","tag":"Workflows","count":11},{"language":"default","tag":"Ingest","count":10},{"language":"default","tag":"SSO","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"cli/commands","slug":"/cli/commands","pageMetadata":{"title":"Command reference","description":"Every hookie command, generated from the same tool catalog the CLI builds itself from.","icon":"list","href":"/cli/commands"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Every hookie command, generated from the same tool catalog the CLI builds itself from.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Most of this CLI is `,_jsx(_components.strong,{children:`generated`}),`. Commands, flags, help text and validation all come from the tool catalog that also defines what a `,_jsx(_components.a,{href:`/connected-agents`,children:`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.`]}),`\n`,_jsx(_components.p,{children:`Which is also why this page is worth trusting: it is produced from that catalog rather than written alongside it.`}),`\n`,_jsx(Heading,{level:`2`,id:`reading-it`,children:`Reading it`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`grou`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`p`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`ver`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`b`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> [flags]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`grou`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`p`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> `}),_jsx(_components.span,{style:{color:`#6A9955`,\"--shiki-dark\":`#6A9955`},children:`# means \u003cgroup> list`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`grou`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`p`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> `}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:`--help`}),_jsx(_components.span,{style:{color:`#6A9955`,\"--shiki-dark\":`#6A9955`},children:` # the group's commands`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`grou`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`p`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`ver`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`b`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> `}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:`--help`}),_jsx(_components.span,{style:{color:`#6A9955`,\"--shiki-dark\":`#6A9955`},children:` # usage, the flags with their types and which are required, and an example`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` help`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`grou`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`p`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> \u003c`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`ver`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`b`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`> `}),_jsx(_components.span,{style:{color:`#6A9955`,\"--shiki-dark\":`#6A9955`},children:`# the same`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Every command has its own help, the hand-written ones included: `,_jsx(_components.code,{children:`hookie replay --help`}),` shows `,_jsx(_components.code,{children:`--since`}),`, `,_jsx(_components.code,{children:`--failed`}),`, `,_jsx(_components.code,{children:`--destination`}),` and `,_jsx(_components.code,{children:`--limit`}),` with an example, and `,_jsx(_components.code,{children:`hookie login --help`}),` shows `,_jsx(_components.code,{children:`--scope`}),`, `,_jsx(_components.code,{children:`--no-open`}),`, `,_jsx(_components.code,{children:`--name`}),` and `,_jsx(_components.code,{children:`--reregister`}),`.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`*`}),` marks a `,_jsx(_components.strong,{children:`required`}),` flag.`]}),`\n`,_jsxs(_components.li,{children:[`⚠️ marks a command that `,_jsx(_components.strong,{children:`asks before acting`}),`. That gate reads the tool catalog, never the word “delete”. `,_jsx(_components.code,{children:`hookie workflows delete`}),` only deactivates, and an update undoes it, so it asks only with `,_jsx(_components.code,{children:`--permanent`}),`. `,_jsx(_components.code,{children:`hookie keys revoke`}),` destroys a credential and has no “delete” in its name.`]}),`\n`,_jsxs(_components.li,{children:[`A flag name is the API field in kebab case, so `,_jsx(_components.code,{children:`webhook_id`}),` is `,_jsx(_components.code,{children:`--webhook-id`}),`. Where two sibling routes spell the same field differently — create takes `,_jsx(_components.code,{children:`datasetFilter`}),`, update takes `,_jsx(_components.code,{children:`dataset_filter`}),` — the `,_jsx(_components.strong,{children:`flag`}),` is the same on both and the CLI sends whichever spelling that route wants.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`An unknown flag is an error`}),`, with a suggestion. `,_jsx(_components.code,{children:`--datset orders`}),` would otherwise be a successful call that quietly did the wrong thing.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Every command also takes the global flags: `,_jsx(_components.code,{children:`--url`}),`, `,_jsx(_components.code,{children:`--project`}),`, `,_jsx(_components.code,{children:`--json`}),`, `,_jsx(_components.code,{children:`--reveal`}),`, `,_jsx(_components.code,{children:`--redact`}),`, `,_jsx(_components.code,{children:`--yes`}),`, `,_jsx(_components.code,{children:`--quiet`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`--project`}),` takes a `,_jsx(_components.strong,{children:`slug or an id`}),`, and with neither it uses your workspace’s Default project. There is deliberately no `,_jsx(_components.code,{children:`--project-id`}),`: two ways to say the same thing, one of which silently 404s on a slug, is worse than one.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`hand-written-commands`,children:`Hand-written commands`}),`\n`,_jsxs(_components.p,{children:[`These are not single API calls, so they are not generated. `,_jsx(_components.a,{href:`/cli/operations`,children:`Operations`}),` covers them in full.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie login`}),` · `,_jsx(_components.code,{children:`logout`}),` · `,_jsx(_components.code,{children:`whoami`}),` · `,_jsx(_components.code,{children:`status`})]}),_jsx(_components.td,{children:`Connect this machine, and see what it is connected to.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie send --endpoint \u003cx> --data @f.json`})}),_jsx(_components.td,{children:`Send a test event to an endpoint’s public URL.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie replay \u003cid>`}),` · `,_jsx(_components.code,{children:`replay --since 1h --failed`})]}),_jsx(_components.td,{children:`Redeliver one, or a window.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie open --project x --tab deliveries`})}),_jsx(_components.td,{children:`Open the console at a project.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie apply -f hookie.yml`}),` · `,_jsx(_components.code,{children:`hookie diff -f hookie.yml`})]}),_jsxs(_components.td,{children:[`Converge a project on a file, or show what that would change. See `,_jsx(_components.a,{href:`/cli/configuration`,children:`Configuration`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie export [--format yaml|json] [-o file]`})}),_jsxs(_components.td,{children:[`Write a project’s configuration as a file that `,_jsx(_components.code,{children:`apply`}),` and `,_jsx(_components.code,{children:`diff`}),` read. See `,_jsx(_components.a,{href:`/cli/configuration#start-from-what-a-project-already-has`,children:`Configuration`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`generated-commands`,children:`Generated commands`}),`\n`,_jsx(Heading,{level:`3`,id:`ai-agents`,children:`ai-agents`}),`\n`,_jsxs(_components.p,{children:[`Named model configurations a workflow’s `,_jsx(_components.code,{children:`agent_call`}),` step runs by id. `,_jsx(_components.code,{children:`update`}),` changes only the flags you pass.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ai-agents list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`This project’s AI agents: named model configurations (model, system prompt, memory dataset, reply cap) that a workflow’s agent_call step runs by id.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ai-agents get`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--agent-id*`})}),_jsx(_components.td,{children:`One AI agent in full, including its system prompt.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ai-agents create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --system-prompt --model --memory-dataset --max-tokens --active`})}),_jsxs(_components.td,{children:[`Create an AI agent: a named model configuration that workflows invoke with an agent_call step (`,_jsx(_components.code,{children:`{type:\"agent_call\", agent_id}`}),`).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ai-agents update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--agent-id* --name --system-prompt --model --memory-dataset --max-tokens --active`})}),_jsx(_components.td,{children:`Change an AI agent in place.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ai-agents delete`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--agent-id*`})}),_jsx(_components.td,{children:`Retire an AI agent: it is set inactive, so a workflow step that names it fails until it is reactivated with update_ai_agent active:true.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`cron-triggers`,children:`cron-triggers`}),`\n`,_jsxs(_components.p,{children:[`Owner/admin in the console, so a connected agent needs `,_jsx(_components.code,{children:`hookie:manage`}),`. `,_jsx(_components.code,{children:`--payload`}),` is JSON; `,_jsx(_components.code,{children:`{{now}}`}),` in it becomes the fire time.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie cron-triggers list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`This project’s cron triggers: schedule, time zone, payload template, dataset, and the last and next run.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie cron-triggers preview`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--schedule* --timezone`})}),_jsx(_components.td,{children:`The next five times a cron schedule would fire, before anything is saved — or the reason it cannot be stored.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie cron-triggers create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --schedule* --timezone --payload --dataset`})}),_jsxs(_components.td,{children:[`Create a cron trigger: on its schedule it emits `,_jsx(_components.code,{children:`payload`}),` as an event, filed into `,_jsx(_components.code,{children:`dataset`}),` if given or routed by the project’s rules if not (a run no rule matches is stored whole, as one record, in `,_jsx(_components.code,{children:`default`}),`), and fanned out like any other event.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie cron-triggers update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--cron-trigger-id* --enabled --name --schedule --timezone --payload --dataset`})}),_jsxs(_components.td,{children:[`Change a cron trigger in place: pause or resume it, rename it, or change its schedule, time zone, payload or dataset. With no dataset, a run no rule matches is stored whole, as one record, in `,_jsx(_components.code,{children:`default`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie cron-triggers test`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--cron-trigger-id*`})}),_jsx(_components.td,{children:`Fire a cron trigger once, now.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie cron-triggers delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--cron-trigger-id*`})}),_jsx(_components.td,{children:`Delete a cron trigger.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`datasets`,children:`datasets`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie datasets list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`The datasets in a project, with per-dataset record counts.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie datasets query`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--dataset* --view --limit --offset`})}),_jsxs(_components.td,{children:[`One page of a dataset’s records (25 by default), newest first; `,_jsx(_components.code,{children:`--view`}),` shapes it through a saved view, and `,_jsx(_components.code,{children:`total`}),` says how many there are in all.`]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`deliveries`,children:`deliveries`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie deliveries list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`Recent outbound deliveries for a project — status, response code, destination.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie deliveries get`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--delivery-id*`})}),_jsx(_components.td,{children:`One delivery in full: its latest response body and every attempt it made.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie deliveries metrics`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--window --destination-id`})}),_jsx(_components.td,{children:`Delivery health per destination: success rate, p50/p95/p99 latency, failed attempts by class, and a time series.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie deliveries search`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--status --destination-id --response-code --min-latency-ms --since --until --limit --offset`})}),_jsx(_components.td,{children:`Search deliveries with filters and paging.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie deliveries replay`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--delivery-id*`})}),_jsx(_components.td,{children:`Re-queue a past delivery to its destination.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`destinations`,children:`destinations`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie destinations list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`A project’s outbound destinations.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie destinations create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --type --url --config --dataset-filter --headers --auth --transform --alert-url`})}),_jsxs(_components.td,{children:[`Create an outbound destination. `,_jsx(_components.code,{children:`--type`}),` is `,_jsx(_components.code,{children:`webhook`}),` (the default), which needs `,_jsx(_components.code,{children:`--url`}),`, or `,_jsx(_components.code,{children:`slack`}),` or `,_jsx(_components.code,{children:`s3`}),`, which take `,_jsx(_components.code,{children:`--config`}),` instead and no `,_jsx(_components.code,{children:`--url`}),`, `,_jsx(_components.code,{children:`--headers`}),` or `,_jsx(_components.code,{children:`--auth`}),`. Optionally with custom headers, authentication, a body template and an alert URL (see `,_jsx(_components.a,{href:`/destinations`,children:`Destination types and options`}),`).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie destinations update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--destination-id* --name --url --config --enabled --dataset-filter --timeout-seconds --max-per-second --max-concurrency --headers --auth --transform --alert-url`})}),_jsxs(_components.td,{children:[`Rename a destination, move it to a new https URL or change a Slack or S3 destination’s `,_jsx(_components.code,{children:`--config`}),` (settings left out keep their stored values), enable or disable it (enabling one Hookie switched off for failing clears its failure streak and sends what it held), change which datasets it receives, set its headers, authentication, body template or alert URL, or set its delivery limits: a request timeout, a maximum send rate and a concurrency cap (`,_jsx(_components.code,{children:`null`}),` restores the default: 10 s, unlimited, unlimited).`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie destinations delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--destination-id*`})}),_jsx(_components.td,{children:`Delete a destination.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`endpoints`,children:`endpoints`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie endpoints list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`A project’s endpoints.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie endpoints activity`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--webhook-id* --kind --limit --offset`})}),_jsx(_components.td,{children:`One endpoint’s received and refused requests over the last 7 days, and why each was refused.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie endpoints create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --slug --dataset --criteria --mappings --enabled --ip-allowlist --verification --redirect-url --cors-origins --handshake --handshake-secret`})}),_jsxs(_components.td,{children:[`Create an endpoint. `,_jsx(_components.code,{children:`--slug`}),` and `,_jsx(_components.code,{children:`--dataset`}),` are optional: the slug is made from the name, and the dataset is the name as an identifier, or `,_jsx(_components.code,{children:`default`}),`. `,_jsx(_components.code,{children:`--verification`}),` turns on `,_jsx(_components.a,{href:`/endpoint-verification`,children:`provider signature verification`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie endpoints update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--webhook-id* --enabled --name --dataset --ip-allowlist --redirect-url --cors-origins --handshake --handshake-secret --verification`})}),_jsx(_components.td,{children:`Change an endpoint in place: enable or disable it, rename it, re-point its dataset, or set its IP allowlist, form redirect, allowed browser origins, URL verification or provider signature verification. Pass at least one.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie endpoints rotate`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--webhook-id* --overlap-hours`})}),_jsx(_components.td,{children:`Give an endpoint a new URL; the old one keeps working for the overlap (default 24 hours).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie endpoints rotate-secret`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--webhook-id* --secret* --overlap-hours`})}),_jsx(_components.td,{children:`Replace the provider signing secret an endpoint verifies with, when the provider rolls it; the old secret keeps verifying for the overlap (default 24 hours, 0 ends it at once).`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie endpoints delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--webhook-id*`})}),_jsx(_components.td,{children:`Delete an endpoint.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie endpoints version`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--webhook-id* --name* --slug* --dataset* --criteria --mappings --enabled --major`})}),_jsx(_components.td,{children:`Publish a new version of an endpoint with different criteria, mappings or dataset, leaving the old version and its URL working so senders can move over.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`events`,children:`events`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie events search`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--q --dataset --since --until --limit --offset`})}),_jsx(_components.td,{children:`Search stored records across datasets, with a free-text term, a dataset filter, a time window and paging.`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`held-deliveries`,children:`held-deliveries`}),`\n`,_jsxs(_components.p,{children:[`Deliveries held because the workspace used its monthly delivery allowance. `,_jsx(_components.code,{children:`hookie held_deliveries`}),` still works as an alias.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie held-deliveries list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`Events whose deliveries are held because the workspace used its monthly delivery allowance, oldest first, with the allowance used this month. Held deliveries are not lost.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie held-deliveries release`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`Send held deliveries, oldest first, while the monthly delivery allowance covers them (after the 1st UTC or an upgrade). Stops at the first event it cannot fully cover.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`keys`,children:`keys`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie keys list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`This project’s ingest keys, metadata only — never the full token.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie keys create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --dataset-default --require-signature --expires-at --ip-allowlist`})}),_jsxs(_components.td,{children:[`Create an ingest key. Returns the plaintext once; `,_jsx(_components.code,{children:`--reveal`}),` prints it. `,_jsx(_components.code,{children:`--dataset-default`}),` names the dataset an event sent with no dataset in the URL is stored in when no rule matches it (`,_jsx(_components.code,{children:`default`}),` if left out).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie keys update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--key-id* --name --expires-at --ip-allowlist`})}),_jsx(_components.td,{children:`Rename a key, or set or clear its expiry or IP allowlist.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie keys rotate`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--key-id* --overlap-hours --expires-at`})}),_jsxs(_components.td,{children:[`Issue a replacement key; the old one keeps working for the overlap (default 24 hours). Returns the new key once; `,_jsx(_components.code,{children:`--reveal`}),` prints it.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie keys revoke`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--key-id*`})}),_jsx(_components.td,{children:`Revoke an ingest key.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`members`,children:`members`}),`\n`,_jsxs(_components.p,{children:[`Read-only, at `,_jsx(_components.code,{children:`hookie:read`}),`. Inviting, changing roles and removing people are for a person in the console: see `,_jsx(_components.a,{href:`/team-members`,children:`Team members`}),`.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie members list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`The people in the current workspace: user_id, email, name, role (owner, admin, developer or viewer) and joined_at, owner first. Also max_members, the plan’s member limit (null: unlimited).`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`portal-tokens`,children:`portal-tokens`}),`\n`,_jsxs(_components.p,{children:[`Customer links to the project’s portal. `,_jsx(_components.code,{children:`create`}),` returns the token once; `,_jsx(_components.code,{children:`--reveal`}),` prints it.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie portal-tokens list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--portal-id*`})}),_jsx(_components.td,{children:`The access links issued for a customer portal: customer_id, token_prefix, expires_at, revoked_at.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie portal-tokens create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--portal-id* --customer-id* --expires-in-days`})}),_jsx(_components.td,{children:`Issue a customer an access link to the portal.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie portal-tokens revoke`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--portal-id* --token-id*`})}),_jsx(_components.td,{children:`Revoke a customer’s portal link.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`portals`,children:`portals`}),`\n`,_jsxs(_components.p,{children:[`The project’s one customer portal. `,_jsx(_components.code,{children:`update`}),` creates it the first time.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie portals get`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`This project’s customer portal, or null if it has none: its id, name, the datasets it exposes (event_types) and whether it is enabled.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie portals update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name --event-types --enabled`})}),_jsx(_components.td,{children:`Create this project’s customer portal, or change it: its name, the datasets it exposes, and whether it is enabled.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie portals delete`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--portal-id*`})}),_jsx(_components.td,{children:`Switch this project’s customer portal off: every customer link stops working.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`project-config`,children:`project-config`}),`\n`,_jsxs(_components.p,{children:[`The same document `,_jsx(_components.code,{children:`hookie export`}),` writes, as JSON. `,_jsx(_components.code,{children:`import`}),` takes it with `,_jsx(_components.code,{children:`--config @file.json`}),`.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie project-config export`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`A project’s configuration as one document (the hookie.yml shape): endpoints, rules, destinations, AI agents, workflows, AI triggers, cron triggers and record views. Nothing secret is in it.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie project-config import`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--config*`})}),_jsx(_components.td,{children:`Create in a project what an exported document describes. Each resource is created through its own route with new endpoint URLs and signing secrets; anything that already exists is skipped, never overwritten.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`projects`,children:`projects`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie projects list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`List the projects in the workspace.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie projects get`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`A project’s details plus its dataset summary.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie projects create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --type`})}),_jsx(_components.td,{children:`Create a project.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`records`,children:`records`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie records get`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--record-id*`})}),_jsx(_components.td,{children:`One record in full, including fields no view selected.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie records delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--record-id*`})}),_jsxs(_components.td,{children:[`Permanently delete one stored record and every copy of it: its raw submission, its deliveries (replays included) and their response bodies, held deliveries, the workflow runs it started, and AI trigger output derived from it. Cannot be undone; see `,_jsx(_components.a,{href:`/data-deletion`,children:`Delete, export and close`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`rules`,children:`rules`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie rules list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`A project’s mapping rules.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie rules create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --dataset* --conditions --mappings --enabled`})}),_jsx(_components.td,{children:`Create a mapping rule. Empty conditions match everything; empty mappings pass the payload through.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie rules update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--rule-id* --enabled --name --dataset --conditions --mappings`})}),_jsx(_components.td,{children:`Change a mapping rule in place: enable or disable it, rename it, point it at another dataset, or replace its conditions or mappings. Send only what changes.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie rules delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--rule-id*`})}),_jsx(_components.td,{children:`Delete a mapping rule.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`sources`,children:`sources`}),`\n`,_jsxs(_components.p,{children:[`Database sources: Hookie polls a Postgres table and files each new row as a record. `,_jsx(_components.code,{children:`--config`}),` is JSON, `,_jsx(_components.code,{children:`{\"url\":\"postgres://…\",\"table\":\"public.orders\"}`}),` or `,_jsx(_components.code,{children:`@source.json`}),`; it holds the database credentials, is encrypted at rest and is never printed back. `,_jsx(_components.code,{children:`--cursor-column`}),` is required: a column that only grows, such as an id or `,_jsx(_components.code,{children:`created_at`}),`, so each poll takes only new rows.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie sources list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`This project’s source connectors (polled databases and HTTP endpoints), with their last run and last error.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie sources create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --type --config* --dataset* --cursor-column* --poll-interval`})}),_jsxs(_components.td,{children:[`Connect a database source: Hookie polls a Postgres table and files each new row into `,_jsx(_components.code,{children:`dataset`}),` as a record, which then fans out to destinations, triggers and workflows like any event.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie sources update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--source-id* --enabled*`})}),_jsx(_components.td,{children:`Pause or resume a database source.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie sources test`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--source-id*`})}),_jsx(_components.td,{children:`Check that a database source can connect and read its table, without storing anything.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie sources delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--source-id*`})}),_jsx(_components.td,{children:`Delete a database source.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`submissions`,children:`submissions`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie submissions search`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--q --since --until --limit --offset`})}),_jsx(_components.td,{children:`Search raw submissions — the body exactly as it arrived, before any rule reshaped it.`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`triggers`,children:`triggers`}),`\n`,_jsx(_components.p,{children:`AI triggers.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie triggers list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`This project’s AI triggers — what each one matches and what it does when it fires.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie triggers create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --dataset* --conditions --instructions* --output-dataset --model --max-tokens`})}),_jsxs(_components.td,{children:[`Create an AI trigger: every record that lands in `,_jsx(_components.code,{children:`dataset`}),` and meets `,_jsx(_components.code,{children:`conditions`}),` runs the model with `,_jsx(_components.code,{children:`instructions`}),` over it, and the reply is stored as a record in `,_jsx(_components.code,{children:`output_dataset`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie triggers update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--trigger-id* --enabled*`})}),_jsx(_components.td,{children:`Enable or disable an AI trigger.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie triggers delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--trigger-id*`})}),_jsx(_components.td,{children:`Delete an AI trigger.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`views`,children:`views`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie views list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--dataset`})}),_jsx(_components.td,{children:`The saved table views for a project, or for one dataset.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie views create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--dataset* --name* --columns* --sort-key --sort-dir --is-default`})}),_jsxs(_components.td,{children:[`Save a table view for a dataset. A column or sort key can be a dotted path into a nested field, such as `,_jsx(_components.code,{children:`customer.email`}),`; a field literally named that wins.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie views delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--view-id*`})}),_jsx(_components.td,{children:`Delete a saved table view.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`workflows`,children:`workflows`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`Workflow definitions in a project.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows get`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--workflow-id*`})}),_jsx(_components.td,{children:`One workflow definition in full: entry dataset, entry conditions and every step.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows runs`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--workflow-id* --state --since --until --limit --offset`})}),_jsx(_components.td,{children:`Instances of one workflow, newest first, 50 per page by default.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows run`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--instance-id*`})}),_jsx(_components.td,{children:`One instance with its per-step event log — which branch was taken, and where it stopped.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --slug --entry-dataset* --entry-conditions --steps* --active`})}),_jsx(_components.td,{children:`Create a multi-step workflow.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--workflow-id* --name* --entry-dataset* --entry-conditions --steps* --active`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Replace`}),` a workflow’s definition.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows delete`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--workflow-id* --permanent`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Deactivate`}),` a workflow; an update with `,_jsx(_components.code,{children:`--active`}),` turns it back on. ⚠️ With `,_jsx(_components.code,{children:`--permanent`}),`, delete it and its run history for good (refused while a run has not finished).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows cancel`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--instance-id*`})}),_jsxs(_components.td,{children:[`Cancel a running or waiting workflow instance. A finished one answers `,_jsx(_components.code,{children:`409`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workflows retry`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--instance-id*`})}),_jsx(_components.td,{children:`Retry a failed, timed-out or (Cloudflare engine) cancelled workflow instance.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`workspace`,children:`workspace`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie workspace get`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`The current workspace: its slug, id, your role and plan.`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`ws-triggers`,children:`ws-triggers`}),`\n`,_jsxs(_components.p,{children:[`Owner/admin in the console, so a connected agent needs `,_jsx(_components.code,{children:`hookie:manage`}),`. `,_jsx(_components.code,{children:`--headers`}),` may carry the socket’s credential; it is encrypted and never printed back.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Flags`}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ws-triggers list`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`—`})}),_jsx(_components.td,{children:`This project’s WebSocket triggers: name, conditions, mappings, dataset, connection status and last error.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ws-triggers create`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--name* --url* --headers --subprotocols --connect-message --conditions --mappings --dataset`})}),_jsxs(_components.td,{children:[`Create a WebSocket trigger: Hookie holds an outbound connection to `,_jsx(_components.code,{children:`url`}),` and turns each frame that meets `,_jsx(_components.code,{children:`conditions`}),` into an event, filed into `,_jsx(_components.code,{children:`dataset`}),` or routed by the project’s rules (a frame no rule matches is stored whole, as one record, in `,_jsx(_components.code,{children:`default`}),`). `,_jsx(_components.code,{children:`--mappings`}),` reshape each frame the way a rule’s do; with none, the frame is kept as it arrived.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ws-triggers update`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--ws-trigger-id* --enabled*`})}),_jsx(_components.td,{children:`Connect or disconnect a WebSocket trigger.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hookie ws-triggers test`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--ws-trigger-id*`})}),_jsx(_components.td,{children:`Open a short-lived connection with a WebSocket trigger’s settings and return the first frames, without storing anything.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`hookie ws-triggers delete`}),` ⚠️`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`--ws-trigger-id*`})}),_jsx(_components.td,{children:`Delete a WebSocket trigger.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`two-that-are-narrower-than-they-look`,children:`Two that are narrower than they look`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`hookie workflows update`}),` is a `,_jsx(_components.strong,{children:`full replace`}),`, not a patch — which is why `,_jsx(_components.code,{children:`--name`}),`, `,_jsx(_components.code,{children:`--entry-dataset`}),` and `,_jsx(_components.code,{children:`--steps`}),` are all required. Omitting one would drop it. Read the current definition first:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` workflows`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` get`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --workflow-id`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` wf_123`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --json`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` > `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`wf.json`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6A9955`,\"--shiki-dark\":`#6A9955`},children:`# edit wf.json, then send the whole thing back`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` workflows`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` update`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --workflow-id`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` wf_123`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --name`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"$(`}),_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`jq`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -r`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` .name wf.json)\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --entry-dataset`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"$(`}),_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`jq`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -r`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` .entry_dataset wf.json)\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --steps`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` @wf-steps.json`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`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 `,_jsx(_components.code,{children:`hookie endpoints version`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`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 `,_jsx(_components.code,{children:`POST /admin/api/projects/{project_id}/rules/test`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`json-flags`,children:`JSON flags`}),`\n`,_jsxs(_components.p,{children:[`A flag whose value is a list or an object takes JSON, or `,_jsx(_components.code,{children:`@file.json`}),` to read it from disk — which is how a workflow’s steps get past your shell’s quoting:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` rules`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --name`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` Orders`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --dataset`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` orders`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --conditions`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` '[{\"path\":\"type\",\"equals\":\"order.created\"}]'`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --mappings`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` @mappings.json`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` rules`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` update`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --rule-id`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` r_123`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --conditions`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` '[{\"path\":\"total\",\"op\":\"gte\",\"value\":100},{\"path\":\"country\",\"op\":\"in\",\"value\":[\"US\",\"CA\"]}]'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` workflows`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --name`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` Scoring`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --entry-dataset`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` leads`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --steps`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` @steps.json`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`A Slack or S3 destination’s `,_jsx(_components.code,{children:`--config`}),` holds a credential, so read it from a file rather than typing it, where it would land in your shell history:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` destinations`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --name`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Orders channel\"`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --type`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` slack`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --config`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` @slack.json`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --dataset-filter`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` orders`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` destinations`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --name`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` Archive`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --type`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` s3`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --config`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` @s3.json`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`A list of plain strings also takes a comma-separated list, because `,_jsx(_components.code,{children:`'[\"orders\",\"shipments\"]'`}),` is a quoting puzzle with no upside:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` destinations`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --name`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` Warehouse`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` https://wh.internal/h`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --dataset-filter`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` orders,shipments`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`hookie`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` destinations`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` update`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --destination-id`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` d_1`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` --dataset-filter`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` null`}),_jsx(_components.span,{style:{color:`#6A9955`,\"--shiki-dark\":`#6A9955`},children:` # null means all datasets`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Command reference","description":"Every hookie command, generated from the same tool catalog the CLI builds itself from.","icon":"list","href":"/cli/commands"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Reading it","slug":"reading-it","depth":2,"children":[]},{"title":"Hand-written commands","slug":"hand-written-commands","depth":2,"children":[]},{"title":"Generated commands","slug":"generated-commands","depth":2,"children":[{"title":"ai-agents","slug":"ai-agents","depth":3,"children":[]},{"title":"cron-triggers","slug":"cron-triggers","depth":3,"children":[]},{"title":"datasets","slug":"datasets","depth":3,"children":[]},{"title":"deliveries","slug":"deliveries","depth":3,"children":[]},{"title":"destinations","slug":"destinations","depth":3,"children":[]},{"title":"endpoints","slug":"endpoints","depth":3,"children":[]},{"title":"events","slug":"events","depth":3,"children":[]},{"title":"held-deliveries","slug":"held-deliveries","depth":3,"children":[]},{"title":"keys","slug":"keys","depth":3,"children":[]},{"title":"members","slug":"members","depth":3,"children":[]},{"title":"portal-tokens","slug":"portal-tokens","depth":3,"children":[]},{"title":"portals","slug":"portals","depth":3,"children":[]},{"title":"project-config","slug":"project-config","depth":3,"children":[]},{"title":"projects","slug":"projects","depth":3,"children":[]},{"title":"records","slug":"records","depth":3,"children":[]},{"title":"rules","slug":"rules","depth":3,"children":[]},{"title":"sources","slug":"sources","depth":3,"children":[]},{"title":"submissions","slug":"submissions","depth":3,"children":[]},{"title":"triggers","slug":"triggers","depth":3,"children":[]},{"title":"views","slug":"views","depth":3,"children":[]},{"title":"workflows","slug":"workflows","depth":3,"children":[]},{"title":"workspace","slug":"workspace","depth":3,"children":[]},{"title":"ws-triggers","slug":"ws-triggers","depth":3,"children":[]}]},{"title":"Two that are narrower than they look","slug":"two-that-are-narrower-than-they-look","depth":2,"children":[]},{"title":"JSON flags","slug":"json-flags","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"hookie-ai","siteName":"Hookie","title":"Command reference - Hookie","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T02:56:39.111Z","originalFileLocation":"cli/commands.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Every hookie command, generated from the same tool catalog the CLI builds itself from.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hookie\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Command reference - Hookie\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every hookie command, generated from the same tool catalog the CLI builds itself from.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hookie\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hookie.ai/cli/commands\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hookie-ai.mintlify.site/_mintlify/api/og/v2?division=CLI\u0026amp;title=Command+reference\u0026amp;description=Every+hookie+command%2C+generated+from+the+same+tool+catalog+the+CLI+builds+itself+from.\u0026amp;theme=b39ff0014d2b1be94ed68740\u0026amp;signature=612dfae35f2569e50212ba2e0dd19e58ed779669bfb7c127f1b54a054910a765\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Command reference - Hookie\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every hookie command, generated from the same tool catalog the CLI builds itself from.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hookie-ai.mintlify.site/_mintlify/api/og/v2?division=CLI\u0026amp;title=Command+reference\u0026amp;description=Every+hookie+command%2C+generated+from+the+same+tool+catalog+the+CLI+builds+itself+from.\u0026amp;theme=b39ff0014d2b1be94ed68740\u0026amp;signature=612dfae35f2569e50212ba2e0dd19e58ed779669bfb7c127f1b54a054910a765\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hookie-ai/swNEJiZkoA-0uCAd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hookie\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2B56A1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hookie.ai/cli/commands\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli/commands.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hookie.ai/#organization\",\"name\":\"Hookie\",\"url\":\"https://docs.hookie.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hookie-ai/3zmwtACPzz3wb-OX/logo/light.svg?fit=max\u0026auto=format\u0026n=3zmwtACPzz3wb-OX\u0026q=85\u0026s=3d05bb847a5407bc7e75e7270aafc101\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hookie.ai#website\",\"name\":\"Hookie\",\"url\":\"https://docs.hookie.ai\",\"publisher\":{\"@id\":\"https://docs.hookie.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hookie.ai/cli/commands#webpage\",\"url\":\"https://docs.hookie.ai/cli/commands\",\"name\":\"Command reference\",\"description\":\"Every hookie command, generated from the same tool catalog the CLI builds itself from.\",\"dateModified\":\"2026-11-18T02:56:39.111Z\",\"isPartOf\":{\"@id\":\"https://docs.hookie.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hookie.ai/cli/commands#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hookie.ai/cli/commands#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CLI\",\"item\":\"https://docs.hookie.ai/cli\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Command reference\",\"item\":\"https://docs.hookie.ai/cli/commands\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.hookie.ai/cli/commands#article\",\"headline\":\"Command reference\",\"name\":\"Command reference\",\"description\":\"Every hookie command, generated from the same tool catalog the CLI builds itself from.\",\"url\":\"https://docs.hookie.ai/cli/commands\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hookie.ai/cli/commands#webpage\"},\"dateModified\":\"2026-11-18T02:56:39.111Z\",\"publisher\":{\"@id\":\"https://docs.hookie.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hookie.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hookie\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hookie\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/cli/commands.md","siteName":"Hookie","nav":{"global":null,"groups":[{"group":"Get started","icon":"rocket","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":{"name":"info-circle","style":"regular","library":"fontawesome"},"href":"/index"},{"title":"Quickstart","icon":{"name":"shipping-fast","style":"regular","library":"fontawesome"},"href":"/quickstart"}]},{"group":"Concepts","icon":"lightbulb","pages":[{"title":"Projects","icon":"folder-tree","href":"/projects"},{"title":"Endpoints and ingest keys","icon":"inbox","href":"/endpoints-and-keys"},{"title":"Datasets and records","icon":"table","href":"/datasets-and-records"},{"title":"Rules and mappings","icon":"route","href":"/rules-and-mappings"},{"title":"Destinations and deliveries","icon":"paper-plane","href":"/destinations-and-deliveries"},{"title":"Limits and plans","icon":"gauge","href":"/limits-and-plans"},{"title":"Billing","icon":"credit-card","href":"/billing"},{"title":"Roles, API keys and connected agents","sidebarTitle":"Roles and agents","icon":"user-shield","href":"/roles-and-agents"},{"title":"Glossary","icon":"book","href":"/glossary"}]},{"group":"CLI","icon":"terminal","pages":[{"title":"CLI","sidebarTitle":"Overview","icon":"terminal","href":"/cli/index"},{"title":"Operations","description":"Add a form, send a test event, find what failed, redeliver it, and open the console at a project, all through your account.","icon":"screwdriver-wrench","href":"/cli/operations"},{"title":"Command reference","icon":"list","href":"/cli/commands"},{"title":"Configuration","description":"hookie.yml, environment variables, profiles and exit codes.","icon":"gear","href":"/cli/configuration"}]},{"group":"Guides","icon":"book-open","pages":[{"title":"Node SDK","icon":"code","href":"/sdk"},{"title":"Forms","icon":"rectangle-list","href":"/forms"},{"title":"Verify signatures","icon":"signature","href":"/signatures"},{"title":"Verify provider signatures","icon":"shield-check","href":"/endpoint-verification"},{"title":"Destination types and options","sidebarTitle":"Destination options","icon":"send","href":"/destinations"},{"title":"Slack app","icon":"slack","href":"/slack-app"},{"title":"Database sources","icon":"database","href":"/database-sources"},{"title":"Ingest keys","icon":"key","href":"/ingest-keys"},{"title":"Live streaming","icon":"radio","href":"/streaming"},{"title":"Workflows \u0026 AI agents","icon":{"name":"robot","style":"regular","library":"fontawesome"},"href":"/workflows"},{"title":"Data workspace","icon":"table","href":"/data-workspace"},{"title":"Workspace Brain","icon":"diagram-project","href":"/knowledge-graph"},{"title":"Customer portal","icon":"users","href":"/customer-portal"},{"title":"Broadcast Logs","icon":"tower-broadcast","href":"/broadcast-logs"},{"title":"Analytics","icon":"chart-line","href":"/analytics"},{"title":"Team members","icon":"users","href":"/team-members"},{"title":"Connected agents","icon":"plug","href":"/connected-agents"},{"title":"Agent self-registration","icon":"robot","href":"/agent-self-registration"},{"title":"WorkOS Agent Auth","icon":"id-badge","href":"/workos-agent-auth"},{"title":"API keys","icon":"lock","href":"/api-keys"},{"title":"Data API","icon":"database","href":"/data-api"},{"title":"Delete, export and close","icon":"trash-can","href":"/data-deletion"},{"title":"API reference","icon":"code","href":"/api-reference"}]},{"group":"API reference","icon":"terminal","pages":[{"group":"Ingest","pages":[{"title":"Meta's URL verification (hub.challenge) on the public webhook URL","deprecated":null,"version":null,"openapi":"/openapi.json get /{workspace}/{project}/{webhook}","href":"/api-reference/ingest/metas-url-verification-hubchallenge-on-the-public-webhook-url"},{"title":"Ingest an event through the public webhook URL","deprecated":null,"version":null,"openapi":"/openapi.json post /{workspace}/{project}/{webhook}","href":"/api-reference/ingest/ingest-an-event-through-the-public-webhook-url"},{"title":"CORS preflight for a page's fetch() to the public webhook URL","deprecated":null,"version":null,"openapi":"/openapi.json options /{workspace}/{project}/{webhook}","href":"/api-reference/ingest/cors-preflight-for-a-pages-fetch-to-the-public-webhook-url"},{"title":"Ingest an event through the public webhook URL, naming its dataset","deprecated":null,"version":null,"openapi":"/openapi.json post /{workspace}/{project}/{webhook}/{dataset}","href":"/api-reference/ingest/ingest-an-event-through-the-public-webhook-url-naming-its-dataset"},{"title":"Ingest an event with an ingest key (PUT alias of ingestEvent)","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/ingest/{ingest_key}","href":"/api-reference/ingest/ingest-an-event-with-an-ingest-key-put-alias-of-ingestevent"},{"title":"Ingest an event with an ingest key, routed by the project's mapping rules, with the key's default dataset as the fallback","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/ingest/{ingest_key}","href":"/api-reference/ingest/ingest-an-event-with-an-ingest-key-routed-by-the-projects-mapping-rules-with-the-keys-default-dataset-as-the-fallback"},{"title":"Ingest an event into a named dataset (PUT alias of ingestEventToDataset)","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/ingest/{ingest_key}/{dataset}","href":"/api-reference/ingest/ingest-an-event-into-a-named-dataset-put-alias-of-ingesteventtodataset"},{"title":"Ingest an event with an ingest key straight into a named dataset","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/ingest/{ingest_key}/{dataset}","href":"/api-reference/ingest/ingest-an-event-with-an-ingest-key-straight-into-a-named-dataset"},{"title":"Ingest into a configured endpoint (PUT alias of ingestWebhookEvent)","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/webhooks/{ingest_key}/{slug}","href":"/api-reference/ingest/ingest-into-a-configured-endpoint-put-alias-of-ingestwebhookevent"},{"title":"Ingest an event into a configured endpoint using an ingest key","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/{ingest_key}/{slug}","href":"/api-reference/ingest/ingest-an-event-into-a-configured-endpoint-using-an-ingest-key"}]},{"group":"Streaming","pages":[{"title":"Tail the ingest key's project live event stream over SSE or WebSocket","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/stream","href":"/api-reference/streaming/tail-the-ingest-keys-project-live-event-stream-over-sse-or-websocket"},{"title":"Tail the current workspace's live event stream over SSE or WebSocket","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/stream","href":"/api-reference/streaming/tail-the-current-workspaces-live-event-stream-over-sse-or-websocket"}]},{"group":"Customer Portal","pages":[{"title":"Get the portal context for the caller's token or session","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/me","href":"/api-reference/customer-portal/get-the-portal-context-for-the-callers-token-or-session"},{"title":"List the dataset/event types this portal exposes","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/event-types","href":"/api-reference/customer-portal/list-the-datasetevent-types-this-portal-exposes"},{"title":"List this customer's own destinations","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/destinations","href":"/api-reference/customer-portal/list-this-customers-own-destinations"},{"title":"Create a destination for this customer","deprecated":null,"version":null,"openapi":"/openapi.json post /portal/api/destinations","href":"/api-reference/customer-portal/create-a-destination-for-this-customer"},{"title":"Edit, pause or resume one of this customer's destinations","deprecated":null,"version":null,"openapi":"/openapi.json put /portal/api/destinations/{id}","href":"/api-reference/customer-portal/edit-pause-or-resume-one-of-this-customers-destinations"},{"title":"Delete one of this customer's destinations","deprecated":null,"version":null,"openapi":"/openapi.json delete /portal/api/destinations/{id}","href":"/api-reference/customer-portal/delete-one-of-this-customers-destinations"},{"title":"Edit, pause or resume one of this customer's destinations","deprecated":null,"version":null,"openapi":"/openapi.json patch /portal/api/destinations/{id}","href":"/api-reference/customer-portal/edit-pause-or-resume-one-of-this-customers-destinations-1"},{"title":"List recent delivery attempts to this customer's destinations","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/deliveries","href":"/api-reference/customer-portal/list-recent-delivery-attempts-to-this-customers-destinations"},{"title":"Trade a portal token for a session cookie","deprecated":null,"version":null,"openapi":"/openapi.json post /portal/api/session","href":"/api-reference/customer-portal/trade-a-portal-token-for-a-session-cookie"},{"title":"Sign out of the portal","deprecated":null,"version":null,"openapi":"/openapi.json delete /portal/api/session","href":"/api-reference/customer-portal/sign-out-of-the-portal"},{"title":"Show a destination's signing secret again","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/destinations/{id}/secret","href":"/api-reference/customer-portal/show-a-destinations-signing-secret-again"},{"title":"Rotate a destination's signing secret, with an overlap","deprecated":null,"version":null,"openapi":"/openapi.json post /portal/api/destinations/{id}/rotate-secret","href":"/api-reference/customer-portal/rotate-a-destinations-signing-secret-with-an-overlap"},{"title":"End a rotation's overlap early","deprecated":null,"version":null,"openapi":"/openapi.json post /portal/api/destinations/{id}/expire-previous-secret","href":"/api-reference/customer-portal/end-a-rotations-overlap-early"},{"title":"One delivery, whole: why it failed","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/deliveries/{id}","href":"/api-reference/customer-portal/one-delivery-whole:-why-it-failed"},{"title":"Send a delivery again","deprecated":null,"version":null,"openapi":"/openapi.json post /portal/api/deliveries/{id}/replay","href":"/api-reference/customer-portal/send-a-delivery-again"},{"title":"Example payloads for each exposed event type, and how to verify a delivery (both signature schemes)","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/examples","href":"/api-reference/customer-portal/example-payloads-for-each-exposed-event-type-and-how-to-verify-a-delivery-both-signature-schemes"},{"title":"Table views the provider shared in the portal","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/views","href":"/api-reference/customer-portal/table-views-the-provider-shared-in-the-portal"},{"title":"One page of a shared view, for the signed-in customer","deprecated":null,"version":null,"openapi":"/openapi.json get /portal/api/views/{id}/records","href":"/api-reference/customer-portal/one-page-of-a-shared-view-for-the-signed-in-customer"}]},{"group":"Account","pages":[{"title":"Current user, workspace and role","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/me","href":"/api-reference/account/current-user-workspace-and-role"}]},{"group":"Dashboard","pages":[{"title":"Workspace home dashboard rollup","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/dashboard/summary","href":"/api-reference/dashboard/workspace-home-dashboard-rollup"},{"title":"Bucketed activity series for the workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/dashboard/timeseries","href":"/api-reference/dashboard/bucketed-activity-series-for-the-workspace"},{"title":"Analytics breakdown by project, endpoint, workflow and dataset","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/dashboard/analytics","href":"/api-reference/dashboard/analytics-breakdown-by-project-endpoint-workflow-and-dataset"}]},{"group":"Projects","pages":[{"title":"List projects in the workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects","href":"/api-reference/projects/list-projects-in-the-workspace"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects","href":"/api-reference/projects/create-a-project"},{"title":"Get one project with resource counts","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}","href":"/api-reference/projects/get-one-project-with-resource-counts"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}","href":"/api-reference/projects/delete-a-project"},{"title":"Rename a project or set its IP allowlist","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}","href":"/api-reference/projects/rename-a-project-or-set-its-ip-allowlist"},{"title":"Export a project's configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/config","href":"/api-reference/projects/export-a-projects-configuration"},{"title":"Import a configuration into a project","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/config","href":"/api-reference/projects/import-a-configuration-into-a-project"},{"title":"Clone a project","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/clone","href":"/api-reference/projects/clone-a-project"}]},{"group":"Stats","pages":[{"title":"Traffic and delivery stats for one project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/stats","href":"/api-reference/stats/traffic-and-delivery-stats-for-one-project"}]},{"group":"Datasets","pages":[{"title":"List datasets with record counts","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/datasets","href":"/api-reference/datasets/list-datasets-with-record-counts"},{"title":"One page of a dataset's records, whole and flattened (export shape)","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/datasets/{dataset}","href":"/api-reference/datasets/one-page-of-a-datasets-records-whole-and-flattened-export-shape"}]},{"group":"Records","pages":[{"title":"Get one record with its full payload","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/records/{id}","href":"/api-reference/records/get-one-record-with-its-full-payload"},{"title":"Delete a record and every copy of it","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/records/{id}","href":"/api-reference/records/delete-a-record-and-every-copy-of-it"},{"title":"One page of a dataset's records, optionally through a saved view","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/datasets/{dataset}/records","href":"/api-reference/records/one-page-of-a-datasets-records-optionally-through-a-saved-view"},{"title":"Retired: records are read by dataset","deprecated":true,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/webhooks/{id}/records","href":"/api-reference/records/retired:-records-are-read-by-dataset"},{"title":"The dataset's latest purge","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/datasets/{dataset}/purge","href":"/api-reference/records/the-datasets-latest-purge"},{"title":"Delete every record in a dataset","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/datasets/{dataset}/purge","href":"/api-reference/records/delete-every-record-in-a-dataset"},{"title":"A project record's chain of custody","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/records/{id}/history","href":"/api-reference/records/a-project-records-chain-of-custody"}]},{"group":"Submissions","pages":[{"title":"List raw submissions","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/submissions","href":"/api-reference/submissions/list-raw-submissions"},{"title":"Set a submission forward status","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/submissions/{id}","href":"/api-reference/submissions/set-a-submission-forward-status"}]},{"group":"Rules","pages":[{"title":"List mapping rules","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/rules","href":"/api-reference/rules/list-mapping-rules"},{"title":"Create a mapping rule","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/rules","href":"/api-reference/rules/create-a-mapping-rule"},{"title":"Get one rule","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/rules/{id}","href":"/api-reference/rules/get-one-rule"},{"title":"Delete a rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/rules/{id}","href":"/api-reference/rules/delete-a-rule"},{"title":"Update a rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/rules/{id}","href":"/api-reference/rules/update-a-rule"},{"title":"Test conditions and mappings against a sample payload","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/rules/test","href":"/api-reference/rules/test-conditions-and-mappings-against-a-sample-payload"}]},{"group":"Webhooks","pages":[{"title":"List endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/webhooks","href":"/api-reference/webhooks/list-endpoints"},{"title":"Create an endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/webhooks","href":"/api-reference/webhooks/create-an-endpoint"},{"title":"Publish a new version of a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/webhooks/{id}/versions","href":"/api-reference/webhooks/publish-a-new-version-of-a-webhook"},{"title":"Get one webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/webhooks/{id}","href":"/api-reference/webhooks/get-one-webhook"},{"title":"Delete a webhook version","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-version"},{"title":"Change an endpoint: enabled, name, dataset, IP allowlist, form redirect, CORS origins, URL verification, signature verification","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/webhooks/{id}","href":"/api-reference/webhooks/change-an-endpoint:-enabled-name-dataset-ip-allowlist-form-redirect-cors-origins-url-verification-signature-verification"},{"title":"Give an endpoint a new public URL, with an overlap","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/webhooks/{id}/rotate","href":"/api-reference/webhooks/give-an-endpoint-a-new-public-url-with-an-overlap"},{"title":"Replace an endpoint's provider signing secret, with an overlap","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/webhooks/{id}/rotate-verification-secret","href":"/api-reference/webhooks/replace-an-endpoints-provider-signing-secret-with-an-overlap"},{"title":"One endpoint's received and refused requests","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/webhooks/{id}/activity","href":"/api-reference/webhooks/one-endpoints-received-and-refused-requests"}]},{"group":"Record views","pages":[{"title":"List saved record views","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/record-views","href":"/api-reference/record-views/list-saved-record-views"},{"title":"Create a record view","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/record-views","href":"/api-reference/record-views/create-a-record-view"},{"title":"Get one view","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/record-views/{id}","href":"/api-reference/record-views/get-one-view"},{"title":"Delete a record view","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/record-views/{id}","href":"/api-reference/record-views/delete-a-record-view"},{"title":"Update a record view","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/record-views/{id}","href":"/api-reference/record-views/update-a-record-view"}]},{"group":"Ingest keys","pages":[{"title":"List ingest keys","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/ingest-keys","href":"/api-reference/ingest-keys/list-ingest-keys"},{"title":"Issue an ingest key","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/ingest-keys","href":"/api-reference/ingest-keys/issue-an-ingest-key"},{"title":"Get one ingest key","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/ingest-keys/{id}","href":"/api-reference/ingest-keys/get-one-ingest-key"},{"title":"Revoke an ingest key","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/ingest-keys/{id}","href":"/api-reference/ingest-keys/revoke-an-ingest-key"},{"title":"Rename an ingest key, or set its expiry or IP allowlist","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/ingest-keys/{id}","href":"/api-reference/ingest-keys/rename-an-ingest-key-or-set-its-expiry-or-ip-allowlist"},{"title":"Rotate an ingest key with an overlap","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/ingest-keys/{id}/rotate","href":"/api-reference/ingest-keys/rotate-an-ingest-key-with-an-overlap"}]},{"group":"Destinations","pages":[{"title":"List outbound destinations","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/destinations","href":"/api-reference/destinations/list-outbound-destinations"},{"title":"Create an outbound destination","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/destinations","href":"/api-reference/destinations/create-an-outbound-destination"},{"title":"Get one destination","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/destinations/{id}","href":"/api-reference/destinations/get-one-destination"},{"title":"Delete a destination","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/destinations/{id}","href":"/api-reference/destinations/delete-a-destination"},{"title":"Edit a destination: name, URL or type settings, on/off, dataset filter, request options, alert URL or delivery limits","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/destinations/{id}","href":"/api-reference/destinations/edit-a-destination:-name-url-or-type-settings-onoff-dataset-filter-request-options-alert-url-or-delivery-limits"},{"title":"Reveal a destination signing secret","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/destinations/{id}/secret","href":"/api-reference/destinations/reveal-a-destination-signing-secret"},{"title":"Rotate a destination signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/destinations/{id}/rotate-secret","href":"/api-reference/destinations/rotate-a-destination-signing-secret"},{"title":"Stop signing with a destination's previous secret","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/destinations/{id}/expire-previous-secret","href":"/api-reference/destinations/stop-signing-with-a-destinations-previous-secret"}]},{"group":"Deliveries","pages":[{"title":"List outbound deliveries","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/deliveries","href":"/api-reference/deliveries/list-outbound-deliveries"},{"title":"Delivery health per destination: success rate, latency percentiles, error classes, time series","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/deliveries/metrics","href":"/api-reference/deliveries/delivery-health-per-destination:-success-rate-latency-percentiles-error-classes-time-series"},{"title":"Replay every delivery that did not arrive, by filter","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/deliveries/replay","href":"/api-reference/deliveries/replay-every-delivery-that-did-not-arrive-by-filter"},{"title":"List events whose deliveries are held past the monthly delivery allowance","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/deliveries/held","href":"/api-reference/deliveries/list-events-whose-deliveries-are-held-past-the-monthly-delivery-allowance"},{"title":"Send held deliveries now that there is room in the allowance","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/deliveries/held/release","href":"/api-reference/deliveries/send-held-deliveries-now-that-there-is-room-in-the-allowance"},{"title":"Get one delivery with its response body and every attempt","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/deliveries/{id}","href":"/api-reference/deliveries/get-one-delivery-with-its-response-body-and-every-attempt"},{"title":"Delete a delivery","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/deliveries/{id}","href":"/api-reference/deliveries/delete-a-delivery"},{"title":"Replay a delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/deliveries/{id}/replay","href":"/api-reference/deliveries/replay-a-delivery"}]},{"group":"Search","pages":[{"title":"Search records (events)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/search/events","href":"/api-reference/search/search-records-events"},{"title":"Search deliveries","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/search/deliveries","href":"/api-reference/search/search-deliveries"},{"title":"Search AI agent runs","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/search/ai-runs","href":"/api-reference/search/search-ai-agent-runs"},{"title":"Search the AI call log","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/search/ai-calls","href":"/api-reference/search/search-the-ai-call-log"},{"title":"Get one AI call in full","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/search/ai-calls/{id}","href":"/api-reference/search/get-one-ai-call-in-full"},{"title":"Search raw submissions","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/search/submissions","href":"/api-reference/search/search-raw-submissions"},{"title":"Correlate any pipeline id across the pipeline","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/search/correlate/{id}","href":"/api-reference/search/correlate-any-pipeline-id-across-the-pipeline"}]},{"group":"Audit","pages":[{"title":"Read the workspace audit log","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/audit","href":"/api-reference/audit/read-the-workspace-audit-log"},{"title":"List the actions recorded in the workspace audit log","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/audit/actions","href":"/api-reference/audit/list-the-actions-recorded-in-the-workspace-audit-log"}]},{"group":"Sources","pages":[{"title":"List inbound source connectors in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/sources","href":"/api-reference/sources/list-inbound-source-connectors-in-a-project"},{"title":"Create a source connector","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/sources","href":"/api-reference/sources/create-a-source-connector"},{"title":"Get one source","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/sources/{source_id}","href":"/api-reference/sources/get-one-source"},{"title":"Delete a source connector","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/sources/{source_id}","href":"/api-reference/sources/delete-a-source-connector"},{"title":"Update a source connector","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/sources/{source_id}","href":"/api-reference/sources/update-a-source-connector"},{"title":"Test a source connector's connection","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/sources/{source_id}/test","href":"/api-reference/sources/test-a-source-connectors-connection"}]},{"group":"Triggers","pages":[{"title":"List agentic-AI event triggers in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/triggers","href":"/api-reference/triggers/list-agentic-ai-event-triggers-in-a-project"},{"title":"Create an agentic-AI event trigger","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/triggers","href":"/api-reference/triggers/create-an-agentic-ai-event-trigger"},{"title":"Get one trigger","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/triggers/{trigger_id}","href":"/api-reference/triggers/get-one-trigger"},{"title":"Delete an AI trigger","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/triggers/{trigger_id}","href":"/api-reference/triggers/delete-an-ai-trigger"},{"title":"Enable or disable an AI trigger","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/triggers/{trigger_id}","href":"/api-reference/triggers/enable-or-disable-an-ai-trigger"}]},{"group":"Cron triggers","pages":[{"title":"List cron triggers in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/cron-triggers","href":"/api-reference/cron-triggers/list-cron-triggers-in-a-project"},{"title":"Create a cron trigger","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/cron-triggers","href":"/api-reference/cron-triggers/create-a-cron-trigger"},{"title":"Preview a cron schedule's next fire times","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/cron-triggers/preview","href":"/api-reference/cron-triggers/preview-a-cron-schedules-next-fire-times"},{"title":"Get one cron trigger","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/cron-triggers/{cron_trigger_id}","href":"/api-reference/cron-triggers/get-one-cron-trigger"},{"title":"Delete a cron trigger","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/cron-triggers/{cron_trigger_id}","href":"/api-reference/cron-triggers/delete-a-cron-trigger"},{"title":"Update a cron trigger","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/cron-triggers/{cron_trigger_id}","href":"/api-reference/cron-triggers/update-a-cron-trigger"},{"title":"Fire a cron trigger once, immediately","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/cron-triggers/{cron_trigger_id}/test","href":"/api-reference/cron-triggers/fire-a-cron-trigger-once-immediately"}]},{"group":"WebSocket triggers","pages":[{"title":"List WebSocket triggers in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/ws-triggers","href":"/api-reference/websocket-triggers/list-websocket-triggers-in-a-project"},{"title":"Create a WebSocket trigger","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/ws-triggers","href":"/api-reference/websocket-triggers/create-a-websocket-trigger"},{"title":"Get one ws trigger","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/ws-triggers/{ws_trigger_id}","href":"/api-reference/websocket-triggers/get-one-ws-trigger"},{"title":"Delete a WebSocket trigger","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/ws-triggers/{ws_trigger_id}","href":"/api-reference/websocket-triggers/delete-a-websocket-trigger"},{"title":"Edit, pause or resume a WebSocket trigger","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/ws-triggers/{ws_trigger_id}","href":"/api-reference/websocket-triggers/edit-pause-or-resume-a-websocket-trigger"},{"title":"Probe a WebSocket trigger's connection","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/ws-triggers/{ws_trigger_id}/test","href":"/api-reference/websocket-triggers/probe-a-websocket-triggers-connection"}]},{"group":"Workflows","pages":[{"title":"List workflow definitions in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/workflows","href":"/api-reference/workflows/list-workflow-definitions-in-a-project"},{"title":"Create a workflow definition","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/workflows","href":"/api-reference/workflows/create-a-workflow-definition"},{"title":"Get one workflow definition","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/workflows/{workflow_id}","href":"/api-reference/workflows/get-one-workflow-definition"},{"title":"Replace a workflow definition","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/projects/{project_id}/workflows/{workflow_id}","href":"/api-reference/workflows/replace-a-workflow-definition"},{"title":"Deactivate, or permanently delete, a workflow","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/workflows/{workflow_id}","href":"/api-reference/workflows/deactivate-or-permanently-delete-a-workflow"},{"title":"Change part of a workflow (merge)","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/workflows/{workflow_id}","href":"/api-reference/workflows/change-part-of-a-workflow-merge"},{"title":"List instances of one workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/workflows/{workflow_id}/instances","href":"/api-reference/workflows/list-instances-of-one-workflow"},{"title":"Get a workflow instance with its step events and per-step status","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/workflow-instances/{instance_id}","href":"/api-reference/workflows/get-a-workflow-instance-with-its-step-events-and-per-step-status"},{"title":"Delete a workflow run","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/workflow-instances/{instance_id}","href":"/api-reference/workflows/delete-a-workflow-run"},{"title":"Cancel a workflow instance","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/workflow-instances/{instance_id}/cancel","href":"/api-reference/workflows/cancel-a-workflow-instance"},{"title":"Retry a workflow instance","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/workflow-instances/{instance_id}/retry","href":"/api-reference/workflows/retry-a-workflow-instance"}]},{"group":"Transforms","pages":[{"title":"List scripted transforms in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/transforms","href":"/api-reference/transforms/list-scripted-transforms-in-a-project"},{"title":"Create a scripted transform","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/transforms","href":"/api-reference/transforms/create-a-scripted-transform"},{"title":"Run a transform against a sample, with no side effects","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/transforms/test","href":"/api-reference/transforms/run-a-transform-against-a-sample-with-no-side-effects"},{"title":"Get a scripted transform","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/transforms/{transform_id}","href":"/api-reference/transforms/get-a-scripted-transform"},{"title":"Delete a scripted transform and its versions","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/transforms/{transform_id}","href":"/api-reference/transforms/delete-a-scripted-transform-and-its-versions"},{"title":"Change a scripted transform","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/transforms/{transform_id}","href":"/api-reference/transforms/change-a-scripted-transform"},{"title":"A transform's versions, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/transforms/{transform_id}/versions","href":"/api-reference/transforms/a-transforms-versions-newest-first"}]},{"group":"AI agents","pages":[{"title":"List AI agents in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/ai-agents","href":"/api-reference/ai-agents/list-ai-agents-in-a-project"},{"title":"Create an AI agent","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/ai-agents","href":"/api-reference/ai-agents/create-an-ai-agent"},{"title":"Get one AI agent","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/ai-agents/{agent_id}","href":"/api-reference/ai-agents/get-one-ai-agent"},{"title":"Replace an AI agent","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/projects/{project_id}/ai-agents/{agent_id}","href":"/api-reference/ai-agents/replace-an-ai-agent"},{"title":"Retire, or permanently delete, an AI agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/ai-agents/{agent_id}","href":"/api-reference/ai-agents/retire-or-permanently-delete-an-ai-agent"},{"title":"Change an AI agent (only the fields sent)","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/ai-agents/{agent_id}","href":"/api-reference/ai-agents/change-an-ai-agent-only-the-fields-sent"},{"title":"Models an AI trigger, agent or workflow AI step may name","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/ai-models","href":"/api-reference/ai-agents/models-an-ai-trigger-agent-or-workflow-ai-step-may-name"}]},{"group":"Portals","pages":[{"title":"The project's one customer portal","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/portal","href":"/api-reference/portals/the-projects-one-customer-portal"},{"title":"Create or update the project's customer portal","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/projects/{project_id}/portal","href":"/api-reference/portals/create-or-update-the-projects-customer-portal"},{"title":"Remove the project's customer portal for good","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/portal","href":"/api-reference/portals/remove-the-projects-customer-portal-for-good"},{"title":"Create or update the project's customer portal (PATCH, same as PUT)","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/portal","href":"/api-reference/portals/create-or-update-the-projects-customer-portal-patch-same-as-put"},{"title":"List customer portals in a project","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/portals","href":"/api-reference/portals/list-customer-portals-in-a-project"},{"title":"Create a customer portal","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/portals","href":"/api-reference/portals/create-a-customer-portal"},{"title":"Get one customer portal","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/portals/{portal_id}","href":"/api-reference/portals/get-one-customer-portal"},{"title":"Update a customer portal","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/projects/{project_id}/portals/{portal_id}","href":"/api-reference/portals/update-a-customer-portal"},{"title":"Disable a customer portal","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/portals/{portal_id}","href":"/api-reference/portals/disable-a-customer-portal"},{"title":"Update a customer portal (PATCH, same as PUT)","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/portals/{portal_id}","href":"/api-reference/portals/update-a-customer-portal-patch-same-as-put"},{"title":"List a portal's access tokens","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/portals/{portal_id}/tokens","href":"/api-reference/portals/list-a-portals-access-tokens"},{"title":"Issue or revoke a portal access token","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/portals/{portal_id}/tokens","href":"/api-reference/portals/issue-or-revoke-a-portal-access-token"}]},{"group":"Connected agents","pages":[{"title":"List the signed-in user's OAuth-connected coding agents","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/agents","href":"/api-reference/connected-agents/list-the-signed-in-users-oauth-connected-coding-agents"},{"title":"Revoke a connected agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/agents/{grant_id}","href":"/api-reference/connected-agents/revoke-a-connected-agent"},{"title":"Change what a connected agent may do","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/agents/{grant_id}","href":"/api-reference/connected-agents/change-what-a-connected-agent-may-do"}]},{"group":"SSO","pages":[{"title":"List workspace SSO configurations","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/sso","href":"/api-reference/sso/list-workspace-sso-configurations"},{"title":"Create a workspace SSO configuration (not available)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/sso","href":"/api-reference/sso/create-a-workspace-sso-configuration-not-available"},{"title":"Replace a workspace SSO configuration (not available)","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/sso/{sso_config_id}","href":"/api-reference/sso/replace-a-workspace-sso-configuration-not-available"},{"title":"Delete a workspace SSO configuration","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/sso/{sso_config_id}","href":"/api-reference/sso/delete-a-workspace-sso-configuration"},{"title":"Update a workspace SSO configuration (not available)","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/sso/{sso_config_id}","href":"/api-reference/sso/update-a-workspace-sso-configuration-not-available"},{"title":"Check whether an SSO configuration is complete","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/sso/{sso_config_id}/test","href":"/api-reference/sso/check-whether-an-sso-configuration-is-complete"},{"title":"Read the workspace's SSO / Directory Sync request","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/sso/requests","href":"/api-reference/sso/read-the-workspaces-sso-directory-sync-request"},{"title":"Request single sign-on or Directory Sync","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/sso/requests","href":"/api-reference/sso/request-single-sign-on-or-directory-sync"},{"title":"Cancel a pending SSO / Directory Sync request","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/sso/requests/{request_id}","href":"/api-reference/sso/cancel-a-pending-sso-directory-sync-request"},{"title":"Open the WorkOS Admin Portal to set up SSO or Directory Sync","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/sso/portal-link","href":"/api-reference/sso/open-the-workos-admin-portal-to-set-up-sso-or-directory-sync"}]},{"group":"IP allowlist","pages":[{"title":"Read the workspace-level ingest IP allowlist","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/ip-allowlist","href":"/api-reference/ip-allowlist/read-the-workspace-level-ingest-ip-allowlist"},{"title":"Replace the workspace-level ingest IP allowlist","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/ip-allowlist","href":"/api-reference/ip-allowlist/replace-the-workspace-level-ingest-ip-allowlist"},{"title":"Replace the workspace-level ingest IP allowlist","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/ip-allowlist","href":"/api-reference/ip-allowlist/replace-the-workspace-level-ingest-ip-allowlist-1"}]},{"group":"Workspace","pages":[{"title":"The workspace's name, slug and former slugs","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/workspace","href":"/api-reference/workspace/the-workspaces-name-slug-and-former-slugs"},{"title":"Rename the workspace or change its slug","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/workspace","href":"/api-reference/workspace/rename-the-workspace-or-change-its-slug"},{"title":"List the workspace's admin API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/api-keys","href":"/api-reference/workspace/list-the-workspaces-admin-api-keys"},{"title":"Create an admin API key (shown once)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/api-keys","href":"/api-reference/workspace/create-an-admin-api-key-shown-once"},{"title":"Revoke an admin API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/api-keys/{key_id}","href":"/api-reference/workspace/revoke-an-admin-api-key"},{"title":"The pending workspace closure, if any","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/workspace/closure","href":"/api-reference/workspace/the-pending-workspace-closure-if-any"},{"title":"Close the workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/workspace/closure","href":"/api-reference/workspace/close-the-workspace"},{"title":"Undo a pending closure","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/workspace/closure","href":"/api-reference/workspace/undo-a-pending-closure"},{"title":"Export all of the workspace's data","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/workspace/export","href":"/api-reference/workspace/export-all-of-the-workspaces-data"},{"title":"List the workspace's pending invites","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/invites","href":"/api-reference/workspace/list-the-workspaces-pending-invites"},{"title":"Create a shareable invite link","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/invites","href":"/api-reference/workspace/create-a-shareable-invite-link"},{"title":"Revoke a pending invite","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/invites/{invite_id}","href":"/api-reference/workspace/revoke-a-pending-invite"},{"title":"Join a workspace with an invite link's token","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/invites/accept","href":"/api-reference/workspace/join-a-workspace-with-an-invite-links-token"},{"title":"See what an invite link's token would join, without joining","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/invites/preview","href":"/api-reference/workspace/see-what-an-invite-links-token-would-join-without-joining"},{"title":"List the workspace's members","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/members","href":"/api-reference/workspace/list-the-workspaces-members"},{"title":"Remove a member, or leave the workspace","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/members/{user_id}","href":"/api-reference/workspace/remove-a-member-or-leave-the-workspace"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/members/{user_id}","href":"/api-reference/workspace/change-a-members-role"},{"title":"Transfer ownership to another member","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/members/transfer-ownership","href":"/api-reference/workspace/transfer-ownership-to-another-member"},{"title":"List the workspaces the caller belongs to","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/workspaces","href":"/api-reference/workspace/list-the-workspaces-the-caller-belongs-to"},{"title":"Switch the caller's active workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/workspaces/active","href":"/api-reference/workspace/switch-the-callers-active-workspace"},{"title":"The workspace's Google Workspace domain link","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/workspace/google-domain","href":"/api-reference/workspace/the-workspaces-google-workspace-domain-link"},{"title":"Link the owner's Google Workspace domain","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/workspace/google-domain","href":"/api-reference/workspace/link-the-owners-google-workspace-domain"},{"title":"Unlink the Google Workspace domain","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/workspace/google-domain","href":"/api-reference/workspace/unlink-the-google-workspace-domain"},{"title":"Change the role people from the linked domain join with","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/workspace/google-domain","href":"/api-reference/workspace/change-the-role-people-from-the-linked-domain-join-with"},{"title":"See what a claim token would take over","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/agent-accounts/claim-preview","href":"/api-reference/workspace/see-what-a-claim-token-would-take-over"},{"title":"Take ownership of a workspace an AI agent registered","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/agent-accounts/claim","href":"/api-reference/workspace/take-ownership-of-a-workspace-an-ai-agent-registered"}]},{"group":"Billing","pages":[{"title":"Current plan, subscription and display prices","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/billing/status","href":"/api-reference/billing/current-plan-subscription-and-display-prices"},{"title":"Start a new subscription via Stripe Checkout","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/billing/subscribe","href":"/api-reference/billing/start-a-new-subscription-via-stripe-checkout"},{"title":"Renewal date, payment failures, a pending cancellation and invoices, from Stripe","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/billing/details","href":"/api-reference/billing/renewal-date-payment-failures-a-pending-cancellation-and-invoices-from-stripe"},{"title":"Open Stripe's Customer Portal for this workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/billing/portal","href":"/api-reference/billing/open-stripes-customer-portal-for-this-workspace"},{"title":"Add the Brain add-on","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/billing/brain-addon","href":"/api-reference/billing/add-the-brain-add-on"},{"title":"Remove the Brain add-on","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/billing/brain-addon","href":"/api-reference/billing/remove-the-brain-add-on"}]},{"group":"Presets","pages":[{"title":"Outbound destination preset catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/destination-presets","href":"/api-reference/presets/outbound-destination-preset-catalog"},{"title":"Inbound source preset catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/source-presets","href":"/api-reference/presets/inbound-source-preset-catalog"}]},{"group":"Data API","pages":[{"title":"The datasets this key may read, and their columns","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/data","href":"/api-reference/data-api/the-datasets-this-key-may-read-and-their-columns"},{"title":"One page of an exposed dataset, exposed columns only","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/data/{dataset}","href":"/api-reference/data-api/one-page-of-an-exposed-dataset-exposed-columns-only"},{"title":"What the project exposes to the Data API, and its keys (metadata only)","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/data-api","href":"/api-reference/data-api/what-the-project-exposes-to-the-data-api-and-its-keys-metadata-only"},{"title":"Replace what the project exposes","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/projects/{project_id}/data-api/exposures","href":"/api-reference/data-api/replace-what-the-project-exposes"},{"title":"Replace what the project exposes (PATCH, same as PUT)","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/data-api/exposures","href":"/api-reference/data-api/replace-what-the-project-exposes-patch-same-as-put"},{"title":"Create a read-only Data API key (the plaintext is returned once)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/data-api/keys","href":"/api-reference/data-api/create-a-read-only-data-api-key-the-plaintext-is-returned-once"},{"title":"Revoke a Data API key; it stops working immediately","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/data-api/keys/{key_id}","href":"/api-reference/data-api/revoke-a-data-api-key;-it-stops-working-immediately"}]},{"group":"Broadcast Logs","pages":[{"title":"The project's Broadcast Logs integration (or null) and the vendor catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/telemetry","href":"/api-reference/broadcast-logs/the-projects-broadcast-logs-integration-or-null-and-the-vendor-catalog"},{"title":"Start forwarding the project's logs and traces over OTLP/HTTP (JSON) to one tool","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/telemetry","href":"/api-reference/broadcast-logs/start-forwarding-the-projects-logs-and-traces-over-otlphttp-json-to-one-tool"},{"title":"Remove the integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/projects/{project_id}/telemetry","href":"/api-reference/broadcast-logs/remove-the-integration"},{"title":"Change the integration's settings or secrets, or enable / disable it","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/projects/{project_id}/telemetry","href":"/api-reference/broadcast-logs/change-the-integrations-settings-or-secrets-or-enable-disable-it"},{"title":"Send one test log record (and span) to a draft or the saved configuration","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/projects/{project_id}/telemetry/test","href":"/api-reference/broadcast-logs/send-one-test-log-record-and-span-to-a-draft-or-the-saved-configuration"}]},{"group":"Observability","pages":[{"title":"A project's flagged events: filtered and routing failed","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/errors","href":"/api-reference/observability/a-projects-flagged-events:-filtered-and-routing-failed"},{"title":"One flagged event, with its whole payload","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/projects/{project_id}/errors/{id}","href":"/api-reference/observability/one-flagged-event-with-its-whole-payload"}]},{"group":"Status","pages":[{"title":"Is the API up?","deprecated":null,"version":null,"openapi":"/openapi.json get /health","href":"/api-reference/status/is-the-api-up?"},{"title":"CORS preflight for /health","deprecated":null,"version":null,"openapi":"/openapi.json options /health","href":"/api-reference/status/cors-preflight-for-health"},{"title":"Is the API up? (headers only)","deprecated":null,"version":null,"openapi":"/openapi.json head /health","href":"/api-reference/status/is-the-api-up?-headers-only"}]},{"group":"Agents","pages":[{"title":"Get a proof-of-work challenge to register an agent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents/register/challenge","href":"/api-reference/agents/get-a-proof-of-work-challenge-to-register-an-agent"},{"title":"Register an AI agent's own Hookie account","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents/register","href":"/api-reference/agents/register-an-ai-agents-own-hookie-account"}]},{"group":"Data workspace","pages":[{"title":"Read data workspace eligibility and provisioning status","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace","href":"/api-reference/data-workspace/read-data-workspace-eligibility-and-provisioning-status"},{"title":"Provision or resume this workspace’s dedicated D1 database","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/provision","href":"/api-reference/data-workspace/provision-or-resume-this-workspace’s-dedicated-d1-database"},{"title":"List typed workspace tables","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/tables","href":"/api-reference/data-workspace/list-typed-workspace-tables"},{"title":"Create a table","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/tables","href":"/api-reference/data-workspace/create-a-table"},{"title":"Read a table schema","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/tables/{table_id}","href":"/api-reference/data-workspace/read-a-table-schema"},{"title":"Delete a table","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/tables/{table_id}","href":"/api-reference/data-workspace/delete-a-table"},{"title":"Rename a table or add fields","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/tables/{table_id}","href":"/api-reference/data-workspace/rename-a-table-or-add-fields"},{"title":"Read records using a saved view","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/tables/{table_id}/rows","href":"/api-reference/data-workspace/read-records-using-a-saved-view"},{"title":"Insert a typed record","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/tables/{table_id}/rows","href":"/api-reference/data-workspace/insert-a-typed-record"},{"title":"Delete a record using its current version","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/tables/{table_id}/rows/{record_id}","href":"/api-reference/data-workspace/delete-a-record-using-its-current-version"},{"title":"Replace a record using its current version","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/tables/{table_id}/rows/{record_id}","href":"/api-reference/data-workspace/replace-a-record-using-its-current-version"},{"title":"List saved table views","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/tables/{table_id}/views","href":"/api-reference/data-workspace/list-saved-table-views"},{"title":"Create a table view","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/tables/{table_id}/views","href":"/api-reference/data-workspace/create-a-table-view"},{"title":"Delete a saved view","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/tables/{table_id}/views/{view_id}","href":"/api-reference/data-workspace/delete-a-saved-view"},{"title":"Edit visible fields, filters and sort","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/tables/{table_id}/views/{view_id}","href":"/api-reference/data-workspace/edit-visible-fields-filters-and-sort"},{"title":"Preview source field mapping","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/tables/{table_id}/preview","href":"/api-reference/data-workspace/preview-source-field-mapping"},{"title":"List dataset connections and mapping errors","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/tables/{table_id}/inputs","href":"/api-reference/data-workspace/list-dataset-connections-and-mapping-errors"},{"title":"Connect a project dataset to a table","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/tables/{table_id}/inputs","href":"/api-reference/data-workspace/connect-a-project-dataset-to-a-table"},{"title":"Disconnect a dataset","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/tables/{table_id}/inputs/{input_id}","href":"/api-reference/data-workspace/disconnect-a-dataset"},{"title":"Update a dataset connection","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/tables/{table_id}/inputs/{input_id}","href":"/api-reference/data-workspace/update-a-dataset-connection"},{"title":"Import one page of existing dataset records","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/inputs/{input_id}/import","href":"/api-reference/data-workspace/import-one-page-of-existing-dataset-records"},{"title":"List saved dashboards","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/dashboards","href":"/api-reference/data-workspace/list-saved-dashboards"},{"title":"Create a dashboard","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/dashboards","href":"/api-reference/data-workspace/create-a-dashboard"},{"title":"Compute a dashboard across table records","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/dashboards/{dashboard_id}","href":"/api-reference/data-workspace/compute-a-dashboard-across-table-records"},{"title":"Delete a dashboard","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/dashboards/{dashboard_id}","href":"/api-reference/data-workspace/delete-a-dashboard"},{"title":"Edit a dashboard using its current version","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/dashboards/{dashboard_id}","href":"/api-reference/data-workspace/edit-a-dashboard-using-its-current-version"},{"title":"List Brain documents","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/documents","href":"/api-reference/data-workspace/list-brain-documents"},{"title":"Upload a Brain document","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/documents","href":"/api-reference/data-workspace/upload-a-brain-document"},{"title":"Change document retrieval inclusion","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/documents/{document_id}/inclusion","href":"/api-reference/data-workspace/change-document-retrieval-inclusion"},{"title":"List Brain ingestion pipelines","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/pipelines","href":"/api-reference/data-workspace/list-brain-ingestion-pipelines"},{"title":"Create a Brain ingestion pipeline","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/pipelines","href":"/api-reference/data-workspace/create-a-brain-ingestion-pipeline"},{"title":"Get a Brain ingestion pipeline","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/pipelines/{pipeline_id}","href":"/api-reference/data-workspace/get-a-brain-ingestion-pipeline"},{"title":"Delete a Brain ingestion pipeline","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/pipelines/{pipeline_id}","href":"/api-reference/data-workspace/delete-a-brain-ingestion-pipeline"},{"title":"Update a Brain ingestion pipeline","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/pipelines/{pipeline_id}","href":"/api-reference/data-workspace/update-a-brain-ingestion-pipeline"},{"title":"List Brain pipeline runs","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/pipelines/{pipeline_id}/runs","href":"/api-reference/data-workspace/list-brain-pipeline-runs"},{"title":"Start a Brain pipeline backfill run","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/pipelines/{pipeline_id}/runs","href":"/api-reference/data-workspace/start-a-brain-pipeline-backfill-run"},{"title":"Get a Brain pipeline run","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/pipelines/{pipeline_id}/runs/{run_id}","href":"/api-reference/data-workspace/get-a-brain-pipeline-run"},{"title":"Cancel a Brain pipeline run","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/pipelines/{pipeline_id}/runs/{run_id}","href":"/api-reference/data-workspace/cancel-a-brain-pipeline-run"},{"title":"Get a Brain document","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/documents/{document_id}","href":"/api-reference/data-workspace/get-a-brain-document"},{"title":"Delete a Brain document","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/documents/{document_id}","href":"/api-reference/data-workspace/delete-a-brain-document"},{"title":"Download a Brain document's original","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/documents/{document_id}/content","href":"/api-reference/data-workspace/download-a-brain-documents-original"},{"title":"Brain document allowance and usage","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/usage","href":"/api-reference/data-workspace/brain-document-allowance-and-usage"},{"title":"Search Brain documents","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/search","href":"/api-reference/data-workspace/search-brain-documents"},{"title":"List a pipeline's S3 sources","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/pipelines/{pipeline_id}/s3","href":"/api-reference/data-workspace/list-a-pipelines-s3-sources"},{"title":"Set credentials for an S3 source","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/api/data-workspace/pipelines/{pipeline_id}/s3","href":"/api-reference/data-workspace/set-credentials-for-an-s3-source"},{"title":"Remove credentials for an S3 source","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/pipelines/{pipeline_id}/s3","href":"/api-reference/data-workspace/remove-credentials-for-an-s3-source"},{"title":"List AI memories","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/memories","href":"/api-reference/data-workspace/list-ai-memories"},{"title":"Save an AI memory","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/memories","href":"/api-reference/data-workspace/save-an-ai-memory"},{"title":"List chat threads with memories","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/memories/threads","href":"/api-reference/data-workspace/list-chat-threads-with-memories"},{"title":"Get an AI memory","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/memories/{memory_id}","href":"/api-reference/data-workspace/get-an-ai-memory"},{"title":"Delete an AI memory","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/memories/{memory_id}","href":"/api-reference/data-workspace/delete-an-ai-memory"},{"title":"Update an AI memory","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/memories/{memory_id}","href":"/api-reference/data-workspace/update-an-ai-memory"},{"title":"A workspace table record's change history","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/tables/{table_id}/rows/{record_id}/history","href":"/api-reference/data-workspace/a-workspace-table-records-change-history"}]},{"group":"Knowledge graph","pages":[{"title":"Read graph schema and limits","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph","href":"/api-reference/knowledge-graph/read-graph-schema-and-limits"},{"title":"List knowledge nodes","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/nodes","href":"/api-reference/knowledge-graph/list-knowledge-nodes"},{"title":"Create a knowledge node immediately","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/graph/nodes","href":"/api-reference/knowledge-graph/create-a-knowledge-node-immediately"},{"title":"Read a knowledge node","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/nodes/{node_id}","href":"/api-reference/knowledge-graph/read-a-knowledge-node"},{"title":"Delete a node and its connections","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/graph/nodes/{node_id}","href":"/api-reference/knowledge-graph/delete-a-node-and-its-connections"},{"title":"Edit a node against its current revision","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/api/data-workspace/graph/nodes/{node_id}","href":"/api-reference/knowledge-graph/edit-a-node-against-its-current-revision"},{"title":"Read connections among selected nodes","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/edges","href":"/api-reference/knowledge-graph/read-connections-among-selected-nodes"},{"title":"Create or revise a relationship","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/graph/edges","href":"/api-reference/knowledge-graph/create-or-revise-a-relationship"},{"title":"Remove a relationship against its current revision","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/graph/edges","href":"/api-reference/knowledge-graph/remove-a-relationship-against-its-current-revision"},{"title":"Fetch bounded deterministic agent context","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/context","href":"/api-reference/knowledge-graph/fetch-bounded-deterministic-agent-context"},{"title":"Queue asynchronous knowledge changes","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/graph/mutations","href":"/api-reference/knowledge-graph/queue-asynchronous-knowledge-changes"},{"title":"Read a queued mutation or durable receipt","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/mutations/{mutation_id}","href":"/api-reference/knowledge-graph/read-a-queued-mutation-or-durable-receipt"},{"title":"List the first 100 pending changes","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/pending","href":"/api-reference/knowledge-graph/list-the-first-100-pending-changes"},{"title":"Cancel a queued or errored change","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/graph/pending/{mutation_id}","href":"/api-reference/knowledge-graph/cancel-a-queued-or-errored-change"},{"title":"List unresolved conflict proposals","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/conflicts","href":"/api-reference/knowledge-graph/list-unresolved-conflict-proposals"},{"title":"Discard or apply a reviewed conflict","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/graph/conflicts/{mutation_id}/resolve","href":"/api-reference/knowledge-graph/discard-or-apply-a-reviewed-conflict"},{"title":"List explicit project workflow permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/grants","href":"/api-reference/knowledge-graph/list-explicit-project-workflow-permissions"},{"title":"Set project workflow access to the entire workspace graph","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/graph/grants","href":"/api-reference/knowledge-graph/set-project-workflow-access-to-the-entire-workspace-graph"},{"title":"Revoke a project workflow graph grant","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/api/data-workspace/graph/grants/{project_id}","href":"/api-reference/knowledge-graph/revoke-a-project-workflow-graph-grant"},{"title":"List the latest 50 workflow executions","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/runs","href":"/api-reference/knowledge-graph/list-the-latest-50-workflow-executions"},{"title":"Read bounded execution lineage","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/runs/{run_id}","href":"/api-reference/knowledge-graph/read-bounded-execution-lineage"},{"title":"Summarize the entire Workspace Brain","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/api/data-workspace/graph/overview","href":"/api-reference/knowledge-graph/summarize-the-entire-workspace-brain"},{"title":"Include or exclude a table or record from the Brain","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/api/data-workspace/graph/inclusion","href":"/api-reference/knowledge-graph/include-or-exclude-a-table-or-record-from-the-brain"}]},{"group":"Delivery","pages":[{"title":"An outbound delivery to a destination","version":null,"deprecated":null,"openapi":"/openapi.json webhook delivery","href":"/api-reference/delivery/an-outbound-delivery-to-a-destination"}]}]}]},"basePath":"","title":"Command reference - Hookie","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}