marchon/master-zapier-plan-draft
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
master-zapier-plan-draft/research/zapier/raw/function-reference.jsonl
George Lambert b4150c8250 Milestone 0: import zappier billing, Verae middleware, and Zapier research 
Compose-ready workspace: packages/zappier (rate card, portal, Stripe),
packages/verae-zapier-middleware (timestamp + NATS), packages/verae-zapier
(CLI app), vendor/zapier-platform, and research/zapier vendor corpus.

Gate 0 structure checks pass. Product code and research are not yet wired.
2026-09-09 02:37:36 -04:00

191 lines
758 KiB
JSON
Raw Blame History

{"_id": "core_function:z.request", "kind": "core_function", "key": "z.request", "title": "z.request — Authenticated HTTP to the partner API", "summary": "The only HTTP client you should use inside a perform. Adds auth middleware, logging, and status checks.", "body": "# `z.request`\n\n> The only HTTP client you should use inside a perform. Adds auth middleware, logging, and status checks.\n\n## High-level description\n\nThe only HTTP client you should use inside a perform. Adds auth middleware, logging, and status checks.\n\n## Internals\n\nRuns the beforeRequest chain (basic/digest/oauth1 headers, query merge, prepare-request), then Node fetch, then afterResponse (throw-for-status, stale-auth → RefreshAuthError, throttling, log-response). `json` serializes the body; `form` sends urlencoded; `params` are query string; `raw:true` returns a stream (RawHttpResponse). Non-2xx throws ResponseError unless skipThrowForStatus. Same path Zapier uses in production.\n\n## Typed inputs\n\n```ts\ntype HttpMethod = \"GET\" | \"POST\" | \"PUT\" | \"PATCH\" | \"DELETE\" | \"OPTIONS\" | \"HEAD\";\ntype Input =\n | [url: string, options?: HttpRequestOptions]\n | [options: HttpRequestOptions & { url: string }];\ninterface HttpRequestOptions {\n method?: HttpMethod;\n headers?: Record<string, string>;\n body?: string | Buffer | NodeJS.ReadableStream | Record<string, unknown>;\n json?: unknown; // JSON body\n form?: unknown; // application/x-www-form-urlencoded\n params?: Record<string, unknown>;\n raw?: boolean;\n skipThrowForStatus?: boolean;\n removeMissingValuesFrom?: { params?: boolean; body?: boolean };\n skipEncodingChars?: string;\n middlewareData?: Record<string, unknown>;\n timeout?: number;\n redirect?: \"manual\" | \"error\" | \"follow\";\n}\n```\n\n## Outputs\n\n```ts\ninterface HttpResponse<T = any> {\n status: number;\n headers: Headers;\n content: string;\n data: T; // parsed JSON when content-type is JSON\n throwForStatus(): void;\n getHeader(key: string): string | undefined;\n request: HttpRequestOptions;\n}\n// raw:true → RawHttpResponse with .body stream, .buffer(), .json(), .text()\n```\n\n- Signature: `z.request(url, options?) → Promise<HttpResponse>\nz.request(optionsWithUrl) → Promise<HttpResponse>`\n- Category: `http`\n\n## Related functions\n\n- `BeforeRequestMiddleware`\n- `AfterResponseMiddleware`\n- `z.errors.RefreshAuthError`\n- `z.errors.ResponseError`\n- `z.console`\n\n## Twins (MCP / SDK)\n\n- MCP: `execute_zapier_read_action / execute_zapier_write_action (hosted)`\n- SDK: `zapier.fetch(url, { connection, method }) / zapier-sdk curl`\n\n## Examples\n\n### GET with auth middleware\n\n```ts\nconst resp = await z.request('https://api.example.com/v1/contacts');\nreturn resp.data;\n```\n\n### POST JSON\n\n```ts\nconst resp = await z.request({\n url: 'https://api.example.com/v1/contacts',\n method: 'POST',\n json: { name: bundle.inputData.name },\n});\nreturn resp.data;\n```", "usage": "z.request(url, options?) → Promise<HttpResponse>", "signature": "z.request(url, options?) → Promise<HttpResponse>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "GET with auth middleware", "code": "const resp = await z.request('https://api.example.com/v1/contacts');\nreturn resp.data;"}, {"title": "POST JSON", "code": "const resp = await z.request({\n url: 'https://api.example.com/v1/contacts',\n method: 'POST',\n json: { name: bundle.inputData.name },\n});\nreturn resp.data;"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "http", "zapier-platform-core"], "related": ["BeforeRequestMiddleware", "AfterResponseMiddleware", "z.errors.RefreshAuthError", "z.errors.ResponseError", "z.console"], "meta": {"surface": "platform_core", "category": "http", "mcp_twin": "execute_zapier_read_action / execute_zapier_write_action (hosted)", "sdk_twin": "zapier.fetch(url, { connection, method }) / zapier-sdk curl", "internals": "Runs the beforeRequest chain (basic/digest/oauth1 headers, query merge, prepare-request), then Node fetch, then afterResponse (throw-for-status, stale-auth → RefreshAuthError, throttling, log-response). `json` serializes the body; `form` sends urlencoded; `params` are query string; `raw:true` returns a stream (RawHttpResponse). Non-2xx throws ResponseError unless skipThrowForStatus. Same path Zapier uses in production."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.console", "kind": "core_function", "key": "z.console", "title": "z.console — Integration logger", "summary": "Logs that show up in zapier-platform logs and Zap history. Prefer this over console.log.", "body": "# `z.console`\n\n> Logs that show up in zapier-platform logs and Zap history. Prefer this over console.log.\n\n## High-level description\n\nLogs that show up in zapier-platform logs and Zap history. Prefer this over console.log.\n\n## Internals\n\nForwards to Zapier's log pipeline (type=console). Local `zapier-platform test` prints to stdout; production is queried via `zapier-platform logs --type console`.\n\n## Typed inputs\n\n```ts\n(...args: unknown[]) => void\n```\n\n## Outputs\n\n```ts\nvoid\n```\n\n- Signature: `z.console.log|info|warn|error(...args) → void`\n- Category: `debug`\n\n## Related functions\n\n- `zapier-platform logs`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Debug a payload\n\n```ts\nz.console.log('input', bundle.inputData);\n```", "usage": "z.console.log|info|warn|error(...args) → void", "signature": "z.console.log|info|warn|error(...args) → void", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Debug a payload", "code": "z.console.log('input', bundle.inputData);"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "debug", "zapier-platform-core"], "related": ["zapier-platform logs"], "meta": {"surface": "platform_core", "category": "debug", "mcp_twin": null, "sdk_twin": null, "internals": "Forwards to Zapier's log pipeline (type=console). Local `zapier-platform test` prints to stdout; production is queried via `zapier-platform logs --type console`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.dehydrate", "kind": "core_function", "key": "z.dehydrate", "title": "z.dehydrate — Lazy pointer to an expensive object", "summary": "Returns a pointer string. Zapier later calls func(z, bundle) when a downstream step needs the data.", "body": "# `z.dehydrate`\n\n> Returns a pointer string. Zapier later calls func(z, bundle) when a downstream step needs the data.\n\n## High-level description\n\nReturns a pointer string. Zapier later calls func(z, bundle) when a downstream step needs the data.\n\n## Internals\n\nSerializes {method path, inputData} into a hydrate token. At hydrate time the runtime resolves the function from App.hydrators / the original module and invokes it. Use for large payloads you do not want in every trigger item.\n\n## Typed inputs\n\n```ts\n(func: (z: ZObject, bundle: Bundle<T>) => any, inputData?: T, cacheExpiration?: number) => string\n```\n\n## Outputs\n\n```ts\nstring // hydrate pointer, not the payload\n```\n\n- Signature: `z.dehydrate(func, inputData?, cacheExpiration?) → string`\n- Category: `hydration`\n\n## Related functions\n\n- `z.dehydrateFile`\n- `z.stashFile`\n- `HydratorsSchema`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Defer a contact fetch\n\n```ts\nreturn {\n id: contact.id,\n name: contact.name,\n extra: z.dehydrate(getFullContact, { id: contact.id }),\n};\n```", "usage": "z.dehydrate(func, inputData?, cacheExpiration?) → string", "signature": "z.dehydrate(func, inputData?, cacheExpiration?) → string", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Defer a contact fetch", "code": "return {\n id: contact.id,\n name: contact.name,\n extra: z.dehydrate(getFullContact, { id: contact.id }),\n};"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "hydration", "zapier-platform-core"], "related": ["z.dehydrateFile", "z.stashFile", "HydratorsSchema"], "meta": {"surface": "platform_core", "category": "hydration", "mcp_twin": null, "sdk_twin": null, "internals": "Serializes {method path, inputData} into a hydrate token. At hydrate time the runtime resolves the function from App.hydrators / the original module and invokes it. Use for large payloads you do not want in every trigger item."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.dehydratefile", "kind": "core_function", "key": "z.dehydrateFile", "title": "z.dehydrateFile — Lazy pointer to a file", "summary": "File-specific dehydrator. Zapier fetches bytes only when a later step needs the file.", "body": "# `z.dehydrateFile`\n\n> File-specific dehydrator. Zapier fetches bytes only when a later step needs the file.\n\n## High-level description\n\nFile-specific dehydrator. Zapier fetches bytes only when a later step needs the file.\n\n## Internals\n\nSame pointer mechanism as z.dehydrate but marked as a file so the editor treats it as a file field. See example-apps/files.\n\n## Typed inputs\n\n```ts\n(func: (z: ZObject, bundle: Bundle<T>) => any, inputData?: T, cacheExpiration?: number) => string\n```\n\n## Outputs\n\n```ts\nstring\n```\n\n- Signature: `z.dehydrateFile(func, inputData?, cacheExpiration?) → string`\n- Category: `hydration`\n\n## Related functions\n\n- `z.dehydrate`\n- `z.stashFile`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Trigger item with a file\n\n```ts\nreturn { id: file.id, file: z.dehydrateFile(downloadFile, { id: file.id }) };\n```", "usage": "z.dehydrateFile(func, inputData?, cacheExpiration?) → string", "signature": "z.dehydrateFile(func, inputData?, cacheExpiration?) → string", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Trigger item with a file", "code": "return { id: file.id, file: z.dehydrateFile(downloadFile, { id: file.id }) };"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "hydration", "zapier-platform-core"], "related": ["z.dehydrate", "z.stashFile"], "meta": {"surface": "platform_core", "category": "hydration", "mcp_twin": null, "sdk_twin": null, "internals": "Same pointer mechanism as z.dehydrate but marked as a file so the editor treats it as a file field. See example-apps/files."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.stashfile", "kind": "core_function", "key": "z.stashFile", "title": "z.stashFile — Upload bytes and get a public Zapier URL", "summary": "Turns a Buffer, stream, URL string, or Promise<RawHttpResponse> into a short-lived public URL.", "body": "# `z.stashFile`\n\n> Turns a Buffer, stream, URL string, or Promise<RawHttpResponse> into a short-lived public URL.\n\n## High-level description\n\nTurns a Buffer, stream, URL string, or Promise<RawHttpResponse> into a short-lived public URL.\n\n## Internals\n\nUploads to Zapier's file stash. Used by hydrators and file creates. Length/filename/contentType help the stash; streams should pass knownLength when possible.\n\n## Typed inputs\n\n```ts\n(input: string | Buffer | NodeJS.ReadableStream | Promise<RawHttpResponse> | Promise<string>,\n knownLength?: number, filename?: string, contentType?: string) => string\n```\n\n## Outputs\n\n```ts\nstring // https://zapier-dev-files.s3… style URL\n```\n\n- Signature: `z.stashFile(input, knownLength?, filename?, contentType?) → string`\n- Category: `files`\n\n## Related functions\n\n- `z.dehydrateFile`\n- `z.request`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Stash a download\n\n```ts\nconst raw = await z.request({ url: fileUrl, raw: true });\nreturn { file: z.stashFile(raw, undefined, 'report.pdf', 'application/pdf') };\n```", "usage": "z.stashFile(input, knownLength?, filename?, contentType?) → string", "signature": "z.stashFile(input, knownLength?, filename?, contentType?) → string", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Stash a download", "code": "const raw = await z.request({ url: fileUrl, raw: true });\nreturn { file: z.stashFile(raw, undefined, 'report.pdf', 'application/pdf') };"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "files", "zapier-platform-core"], "related": ["z.dehydrateFile", "z.request"], "meta": {"surface": "platform_core", "category": "files", "mcp_twin": null, "sdk_twin": null, "internals": "Uploads to Zapier's file stash. Used by hydrators and file creates. Length/filename/contentType help the stash; streams should pass knownLength when possible."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.cursor.get", "kind": "core_function", "key": "z.cursor.get", "title": "z.cursor.get — Read the polling cursor", "summary": "Per-subscription opaque cursor so a poll can resume from last-seen id/timestamp.", "body": "# `z.cursor.get`\n\n> Per-subscription opaque cursor so a poll can resume from last-seen id/timestamp.\n\n## High-level description\n\nPer-subscription opaque cursor so a poll can resume from last-seen id/timestamp.\n\n## Internals\n\nZapier stores one cursor string per user/zap/trigger. Empty string if never set. Pair with z.cursor.set at the end of perform.\n\n## Typed inputs\n\n```ts\n() => Promise<string>\n```\n\n## Outputs\n\n```ts\nPromise<string>\n```\n\n- Signature: `z.cursor.get() → Promise<string>`\n- Category: `polling`\n\n## Related functions\n\n- `z.cursor.set`\n- `PollingTriggerPerform`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Incremental poll\n\n```ts\nconst since = await z.cursor.get();\nconst rows = await fetchSince(since);\nawait z.cursor.set(rows[0]?.updated_at || since);\nreturn rows;\n```", "usage": "z.cursor.get() → Promise<string>", "signature": "z.cursor.get() → Promise<string>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Incremental poll", "code": "const since = await z.cursor.get();\nconst rows = await fetchSince(since);\nawait z.cursor.set(rows[0]?.updated_at || since);\nreturn rows;"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "polling", "zapier-platform-core"], "related": ["z.cursor.set", "PollingTriggerPerform"], "meta": {"surface": "platform_core", "category": "polling", "mcp_twin": null, "sdk_twin": null, "internals": "Zapier stores one cursor string per user/zap/trigger. Empty string if never set. Pair with z.cursor.set at the end of perform."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.cursor.set", "kind": "core_function", "key": "z.cursor.set", "title": "z.cursor.set — Write the polling cursor", "summary": "Persist an opaque cursor for the next poll.", "body": "# `z.cursor.set`\n\n> Persist an opaque cursor for the next poll.\n\n## High-level description\n\nPersist an opaque cursor for the next poll.\n\n## Internals\n\nReplaces the stored cursor. Keep it small (id or ISO timestamp).\n\n## Typed inputs\n\n```ts\n(cursor: string) => Promise<null>\n```\n\n## Outputs\n\n```ts\nPromise<null>\n```\n\n- Signature: `z.cursor.set(cursor) → Promise<null>`\n- Category: `polling`\n\n## Related functions\n\n- `z.cursor.get`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Save newest id\n\n```ts\nawait z.cursor.set(String(newest.id));\n```", "usage": "z.cursor.set(cursor) → Promise<null>", "signature": "z.cursor.set(cursor) → Promise<null>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Save newest id", "code": "await z.cursor.set(String(newest.id));"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "polling", "zapier-platform-core"], "related": ["z.cursor.get"], "meta": {"surface": "platform_core", "category": "polling", "mcp_twin": null, "sdk_twin": null, "internals": "Replaces the stored cursor. Keep it small (id or ISO timestamp)."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.generatecallbackurl", "kind": "core_function", "key": "z.generateCallbackUrl", "title": "z.generateCallbackUrl — Resume URL for long-running creates", "summary": "Partner API can POST here to resume a create via performResume.", "body": "# `z.generateCallbackUrl`\n\n> Partner API can POST here to resume a create via performResume.\n\n## High-level description\n\nPartner API can POST here to resume a create via performResume.\n\n## Internals\n\nMints a one-shot Zapier URL. Original perform returns quickly; later performResume gets bundle.cleanedRequest + bundle.outputData. See example-apps/callback.\n\n## Typed inputs\n\n```ts\n() => string\n```\n\n## Outputs\n\n```ts\nstring // https://hooks.zapier.com/… callback\n```\n\n- Signature: `z.generateCallbackUrl() → string`\n- Category: `callback`\n\n## Related functions\n\n- `CreatePerformResume`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Kick off async job\n\n```ts\nconst hook = z.generateCallbackUrl();\nawait z.request({ url: '.../jobs', method: 'POST', json: { callback: hook } });\nreturn { pending: true };\n```", "usage": "z.generateCallbackUrl() → string", "signature": "z.generateCallbackUrl() → string", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Kick off async job", "code": "const hook = z.generateCallbackUrl();\nawait z.request({ url: '.../jobs', method: 'POST', json: { callback: hook } });\nreturn { pending: true };"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "callback", "zapier-platform-core"], "related": ["CreatePerformResume"], "meta": {"surface": "platform_core", "category": "callback", "mcp_twin": null, "sdk_twin": null, "internals": "Mints a one-shot Zapier URL. Original perform returns quickly; later performResume gets bundle.cleanedRequest + bundle.outputData. See example-apps/callback."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.hash", "kind": "core_function", "key": "z.hash", "title": "z.hash — Hash helper (Node crypto)", "summary": "Convenience around crypto.createHash. Default hex / binary.", "body": "# `z.hash`\n\n> Convenience around crypto.createHash. Default hex / binary.\n\n## High-level description\n\nConvenience around crypto.createHash. Default hex / binary.\n\n## Internals\n\nalgorithm typically 'sha256'. Used for cache keys and HMAC-style signatures you compute yourself (OAuth1 signing is automatic).\n\n## Typed inputs\n\n```ts\n(algorithm: string, data: string, encoding?: string, input_encoding?: string) => string\n```\n\n## Outputs\n\n```ts\nstring\n```\n\n- Signature: `z.hash(algorithm, data, encoding?, input_encoding?) → string`\n- Category: `crypto`\n\n## Related functions\n\n- —\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### SHA-256 hex\n\n```ts\nconst digest = z.hash('sha256', bundle.inputData.raw);\n```", "usage": "z.hash(algorithm, data, encoding?, input_encoding?) → string", "signature": "z.hash(algorithm, data, encoding?, input_encoding?) → string", "aliases": [], "flags": [], "args": [], "examples": [{"title": "SHA-256 hex", "code": "const digest = z.hash('sha256', bundle.inputData.raw);"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "crypto", "zapier-platform-core"], "related": [], "meta": {"surface": "platform_core", "category": "crypto", "mcp_twin": null, "sdk_twin": null, "internals": "algorithm typically 'sha256'. Used for cache keys and HMAC-style signatures you compute yourself (OAuth1 signing is automatic)."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.json.parse", "kind": "core_function", "key": "z.JSON.parse", "title": "z.JSON.parse — JSON.parse with a clean Zapier error", "summary": "Prefer over JSON.parse so users see a friendly error on bad JSON.", "body": "# `z.JSON.parse`\n\n> Prefer over JSON.parse so users see a friendly error on bad JSON.\n\n## High-level description\n\nPrefer over JSON.parse so users see a friendly error on bad JSON.\n\n## Internals\n\nWraps JSON.parse and rethrows as a user-visible AppError.\n\n## Typed inputs\n\n```ts\n(text: string) => any\n```\n\n## Outputs\n\n```ts\nany\n```\n\n- Signature: `z.JSON.parse(text) → any`\n- Category: `json`\n\n## Related functions\n\n- `z.JSON.stringify`\n- `z.errors.Error`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Parse partner body\n\n```ts\nconst data = z.JSON.parse(resp.content);\n```", "usage": "z.JSON.parse(text) → any", "signature": "z.JSON.parse(text) → any", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Parse partner body", "code": "const data = z.JSON.parse(resp.content);"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "json", "zapier-platform-core"], "related": ["z.JSON.stringify", "z.errors.Error"], "meta": {"surface": "platform_core", "category": "json", "mcp_twin": null, "sdk_twin": null, "internals": "Wraps JSON.parse and rethrows as a user-visible AppError."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.json.stringify", "kind": "core_function", "key": "z.JSON.stringify", "title": "z.JSON.stringify — JSON.stringify on z", "summary": "Same as built-in JSON.stringify; kept for symmetry with z.JSON.parse.", "body": "# `z.JSON.stringify`\n\n> Same as built-in JSON.stringify; kept for symmetry with z.JSON.parse.\n\n## High-level description\n\nSame as built-in JSON.stringify; kept for symmetry with z.JSON.parse.\n\n## Internals\n\nDelegates to JSON.stringify.\n\n## Typed inputs\n\n```ts\n(value: unknown) => string\n```\n\n## Outputs\n\n```ts\nstring\n```\n\n- Signature: `z.JSON.stringify(value) → string`\n- Category: `json`\n\n## Related functions\n\n- `z.JSON.parse`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Serialize\n\n```ts\nconst body = z.JSON.stringify({ ok: true });\n```", "usage": "z.JSON.stringify(value) → string", "signature": "z.JSON.stringify(value) → string", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Serialize", "code": "const body = z.JSON.stringify({ ok: true });"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "json", "zapier-platform-core"], "related": ["z.JSON.parse"], "meta": {"surface": "platform_core", "category": "json", "mcp_twin": null, "sdk_twin": null, "internals": "Delegates to JSON.stringify."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.cache.get", "kind": "core_function", "key": "z.cache.get", "title": "z.cache.get — Read per-auth cache", "summary": "JSON-encodable values scoped to the connected account.", "body": "# `z.cache.get`\n\n> JSON-encodable values scoped to the connected account.\n\n## High-level description\n\nJSON-encodable values scoped to the connected account.\n\n## Internals\n\nZapier-hosted key/value. Use for account-id lookups you would otherwise repeat every poll.\n\n## Typed inputs\n\n```ts\n(key: string) => Promise<any>\n```\n\n## Outputs\n\n```ts\nPromise<any> // undefined/null if missing\n```\n\n- Signature: `z.cache.get(key) → Promise<any>`\n- Category: `cache`\n\n## Related functions\n\n- `z.cache.set`\n- `z.cache.delete`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Memoize org id\n\n```ts\nlet org = await z.cache.get('orgId');\nif (!org) { org = (await fetchOrg()).id; await z.cache.set('orgId', org, 3600); }\n```", "usage": "z.cache.get(key) → Promise<any>", "signature": "z.cache.get(key) → Promise<any>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Memoize org id", "code": "let org = await z.cache.get('orgId');\nif (!org) { org = (await fetchOrg()).id; await z.cache.set('orgId', org, 3600); }"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "cache", "zapier-platform-core"], "related": ["z.cache.set", "z.cache.delete"], "meta": {"surface": "platform_core", "category": "cache", "mcp_twin": null, "sdk_twin": null, "internals": "Zapier-hosted key/value. Use for account-id lookups you would otherwise repeat every poll."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.cache.set", "kind": "core_function", "key": "z.cache.set", "title": "z.cache.set — Write per-auth cache", "summary": "Store JSON-encodable data. ttl in seconds. nx=true sets only if missing.", "body": "# `z.cache.set`\n\n> Store JSON-encodable data. ttl in seconds. nx=true sets only if missing.\n\n## High-level description\n\nStore JSON-encodable data. ttl in seconds. nx=true sets only if missing.\n\n## Internals\n\nscope further namespaces the key. Returns whether the write landed.\n\n## Typed inputs\n\n```ts\n(key: string, value: any, ttl?: number, scope?: string[], nx?: boolean) => Promise<boolean | null>\n```\n\n## Outputs\n\n```ts\nPromise<boolean | null>\n```\n\n- Signature: `z.cache.set(key, value, ttl?, scope?, nx?) → Promise<boolean|null>`\n- Category: `cache`\n\n## Related functions\n\n- `z.cache.get`\n- `z.cache.delete`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### TTL 1h\n\n```ts\nawait z.cache.set('orgId', org.id, 3600);\n```", "usage": "z.cache.set(key, value, ttl?, scope?, nx?) → Promise<boolean|null>", "signature": "z.cache.set(key, value, ttl?, scope?, nx?) → Promise<boolean|null>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "TTL 1h", "code": "await z.cache.set('orgId', org.id, 3600);"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "cache", "zapier-platform-core"], "related": ["z.cache.get", "z.cache.delete"], "meta": {"surface": "platform_core", "category": "cache", "mcp_twin": null, "sdk_twin": null, "internals": "scope further namespaces the key. Returns whether the write landed."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.cache.delete", "kind": "core_function", "key": "z.cache.delete", "title": "z.cache.delete — Delete a cache key", "summary": "Drop stale metadata (e.g. after auth refresh).", "body": "# `z.cache.delete`\n\n> Drop stale metadata (e.g. after auth refresh).\n\n## High-level description\n\nDrop stale metadata (e.g. after auth refresh).\n\n## Internals\n\nRemoves one key from the per-auth cache.\n\n## Typed inputs\n\n```ts\n(key: string) => Promise<boolean>\n```\n\n## Outputs\n\n```ts\nPromise<boolean>\n```\n\n- Signature: `z.cache.delete(key) → Promise<boolean>`\n- Category: `cache`\n\n## Related functions\n\n- `z.cache.get`\n- `z.cache.set`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Invalidate\n\n```ts\nawait z.cache.delete('orgId');\n```", "usage": "z.cache.delete(key) → Promise<boolean>", "signature": "z.cache.delete(key) → Promise<boolean>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Invalidate", "code": "await z.cache.delete('orgId');"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "cache", "zapier-platform-core"], "related": ["z.cache.get", "z.cache.set"], "meta": {"surface": "platform_core", "category": "cache", "mcp_twin": null, "sdk_twin": null, "internals": "Removes one key from the per-auth cache."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.error", "kind": "core_function", "key": "z.errors.Error", "title": "z.errors.Error — User-visible app error", "summary": "Primary error to throw from perform. Message is shown to the user.", "body": "# `z.errors.Error`\n\n> Primary error to throw from perform. Message is shown to the user.\n\n## High-level description\n\nPrimary error to throw from perform. Message is shown to the user.\n\n## Internals\n\nSerializes {message, code, status} as AppError. code/status help Zapier classify retries vs user-fixable failures.\n\n## Typed inputs\n\n```ts\n(message: string, code?: string, status?: number)\n```\n\n## Outputs\n\n```ts\nnever // throws\n```\n\n- Signature: `throw new z.errors.Error(message, code?, status?)`\n- Category: `errors`\n\n## Related functions\n\n- `z.errors.HaltedError`\n- `z.errors.RefreshAuthError`\n- `z.errors.ThrottledError`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Validation\n\n```ts\nthrow new z.errors.Error('Name is required', 'InvalidInput', 400);\n```", "usage": "throw new z.errors.Error(message, code?, status?)", "signature": "throw new z.errors.Error(message, code?, status?)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Validation", "code": "throw new z.errors.Error('Name is required', 'InvalidInput', 400);"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["z.errors.HaltedError", "z.errors.RefreshAuthError", "z.errors.ThrottledError"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": null, "internals": "Serializes {message, code, status} as AppError. code/status help Zapier classify retries vs user-fixable failures."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.haltederror", "kind": "core_function", "key": "z.errors.HaltedError", "title": "z.errors.HaltedError — Stop this run without failing the Zap", "summary": "Filter-out. Use when the payload should be ignored.", "body": "# `z.errors.HaltedError`\n\n> Filter-out. Use when the payload should be ignored.\n\n## High-level description\n\nFilter-out. Use when the payload should be ignored.\n\n## Internals\n\nMarks the run halted, not errored. Zaps stay on. Typical for 'this webhook is not the event we care about'.\n\n## Typed inputs\n\n```ts\n(message?: string)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.HaltedError(message?)`\n- Category: `errors`\n\n## Related functions\n\n- `z.errors.Error`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Ignore other event types\n\n```ts\nif (bundle.cleanedRequest.type !== 'invoice.paid') {\n throw new z.errors.HaltedError('not an invoice.paid event');\n}\n```", "usage": "throw new z.errors.HaltedError(message?)", "signature": "throw new z.errors.HaltedError(message?)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Ignore other event types", "code": "if (bundle.cleanedRequest.type !== 'invoice.paid') {\n throw new z.errors.HaltedError('not an invoice.paid event');\n}"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["z.errors.Error"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": null, "internals": "Marks the run halted, not errored. Zaps stay on. Typical for 'this webhook is not the event we care about'."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.expiredautherror", "kind": "core_function", "key": "z.errors.ExpiredAuthError", "title": "z.errors.ExpiredAuthError — Dead connection — user must reconnect", "summary": "Revoked tokens that cannot be refreshed.", "body": "# `z.errors.ExpiredAuthError`\n\n> Revoked tokens that cannot be refreshed.\n\n## High-level description\n\nRevoked tokens that cannot be refreshed.\n\n## Internals\n\nPauses the Zap and emails the user to reconnect. Do not use for a refreshable 401 — that is RefreshAuthError.\n\n## Typed inputs\n\n```ts\n(message?: string)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.ExpiredAuthError(message?)`\n- Category: `errors`\n\n## Related functions\n\n- `z.errors.RefreshAuthError`\n- `manage_zapier_connections`\n\n## Twins (MCP / SDK)\n\n- MCP: `manage_zapier_connections`\n- SDK: `create-connection / wait-for-new-connection`\n\n## Examples\n\n### Revoked\n\n```ts\nif (resp.status === 403 && resp.data.error === 'revoked') {\n throw new z.errors.ExpiredAuthError('Reconnect this account');\n}\n```", "usage": "throw new z.errors.ExpiredAuthError(message?)", "signature": "throw new z.errors.ExpiredAuthError(message?)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Revoked", "code": "if (resp.status === 403 && resp.data.error === 'revoked') {\n throw new z.errors.ExpiredAuthError('Reconnect this account');\n}"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["z.errors.RefreshAuthError", "manage_zapier_connections"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": "manage_zapier_connections", "sdk_twin": "create-connection / wait-for-new-connection", "internals": "Pauses the Zap and emails the user to reconnect. Do not use for a refreshable 401 — that is RefreshAuthError."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.refreshautherror", "kind": "core_function", "key": "z.errors.RefreshAuthError", "title": "z.errors.RefreshAuthError — Refresh OAuth/session and retry", "summary": "Typical 401 handler. Zapier calls refreshAccessToken / sessionConfig.perform then retries.", "body": "# `z.errors.RefreshAuthError`\n\n> Typical 401 handler. Zapier calls refreshAccessToken / sessionConfig.perform then retries.\n\n## High-level description\n\nTypical 401 handler. Zapier calls refreshAccessToken / sessionConfig.perform then retries.\n\n## Internals\n\nThrown automatically by afterResponse when it sees stale auth; you can also throw it yourself. Only works for oauth2/session with refresh configured.\n\n## Typed inputs\n\n```ts\n(message?: string)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.RefreshAuthError(message?)`\n- Category: `errors`\n\n## Related functions\n\n- `z.errors.ExpiredAuthError`\n- `AfterResponseMiddleware`\n- `AuthenticationOAuth2ConfigSchema`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### 401\n\n```ts\nif (resp.status === 401) throw new z.errors.RefreshAuthError();\n```", "usage": "throw new z.errors.RefreshAuthError(message?)", "signature": "throw new z.errors.RefreshAuthError(message?)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "401", "code": "if (resp.status === 401) throw new z.errors.RefreshAuthError();"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["z.errors.ExpiredAuthError", "AfterResponseMiddleware", "AuthenticationOAuth2ConfigSchema"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": null, "internals": "Thrown automatically by afterResponse when it sees stale auth; you can also throw it yourself. Only works for oauth2/session with refresh configured."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.throttlederror", "kind": "core_function", "key": "z.errors.ThrottledError", "title": "z.errors.ThrottledError — Rate limit — retry after delay", "summary": "Signals 429. Pass delay from Retry-After.", "body": "# `z.errors.ThrottledError`\n\n> Signals 429. Pass delay from Retry-After.\n\n## High-level description\n\nSignals 429. Pass delay from Retry-After.\n\n## Internals\n\nZapier backs off for delaySeconds then retries the perform. Also thrown by afterResponse throw-for-throttling middleware.\n\n## Typed inputs\n\n```ts\n(message: string, delaySeconds?: number)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.ThrottledError(message, delaySeconds?)`\n- Category: `errors`\n\n## Related functions\n\n- `z.request`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `ZAPIER_ACTION_ERROR … N) Retry-After on run-action`\n\n## Examples\n\n### Honor Retry-After\n\n```ts\nthrow new z.errors.ThrottledError('slow down', Number(resp.getHeader('retry-after') || 60));\n```", "usage": "throw new z.errors.ThrottledError(message, delaySeconds?)", "signature": "throw new z.errors.ThrottledError(message, delaySeconds?)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Honor Retry-After", "code": "throw new z.errors.ThrottledError('slow down', Number(resp.getHeader('retry-after') || 60));"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["z.request"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": "ZAPIER_ACTION_ERROR … N) Retry-After on run-action", "internals": "Zapier backs off for delaySeconds then retries the perform. Also thrown by afterResponse throw-for-throttling middleware."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.responseerror", "kind": "core_function", "key": "z.errors.ResponseError", "title": "z.errors.ResponseError — Wrap an HTTP response as an error", "summary": "Usually auto-thrown by z.request on non-2xx.", "body": "# `z.errors.ResponseError`\n\n> Usually auto-thrown by z.request on non-2xx.\n\n## High-level description\n\nUsually auto-thrown by z.request on non-2xx.\n\n## Internals\n\nJSON-stringifies status, content-type, retry-after, content, request URL.\n\n## Typed inputs\n\n```ts\n(response: HttpResponse)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.ResponseError(response)`\n- Category: `errors`\n\n## Related functions\n\n- `z.request`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Manual throw\n\n```ts\nif (resp.status >= 500) throw new z.errors.ResponseError(resp);\n```", "usage": "throw new z.errors.ResponseError(response)", "signature": "throw new z.errors.ResponseError(response)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Manual throw", "code": "if (resp.status >= 500) throw new z.errors.ResponseError(resp);"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["z.request"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": null, "internals": "JSON-stringifies status, content-type, retry-after, content, request URL."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.checkerror", "kind": "core_function", "key": "z.errors.CheckError", "title": "z.errors.CheckError — Platform check failed", "summary": "Raised by runtime checks (trigger not array, create not object, missing id).", "body": "# `z.errors.CheckError`\n\n> Raised by runtime checks (trigger not array, create not object, missing id).\n\n## High-level description\n\nRaised by runtime checks (trigger not array, create not object, missing id).\n\n## Internals\n\nSee packages/core/src/checks/*. You rarely throw this yourself; fix the return shape instead.\n\n## Typed inputs\n\n```ts\n(message?: string)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.CheckError(message?)`\n- Category: `errors`\n\n## Related functions\n\n- `PollingTriggerPerform`\n- `CreatePerform`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n_see signature_", "usage": "throw new z.errors.CheckError(message?)", "signature": "throw new z.errors.CheckError(message?)", "aliases": [], "flags": [], "args": [], "examples": [], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["PollingTriggerPerform", "CreatePerform"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": null, "internals": "See packages/core/src/checks/*. You rarely throw this yourself; fix the return shape instead."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.stoprequesterror", "kind": "core_function", "key": "z.errors.StopRequestError", "title": "z.errors.StopRequestError — Abort an outbound HTTP request from middleware", "summary": "Throw from beforeRequest to cancel z.request without treating it as an app failure.", "body": "# `z.errors.StopRequestError`\n\n> Throw from beforeRequest to cancel z.request without treating it as an app failure.\n\n## High-level description\n\nThrow from beforeRequest to cancel z.request without treating it as an app failure.\n\n## Internals\n\nShort-circuits the HTTP stack. Used when middleware decides the call should not go out.\n\n## Typed inputs\n\n```ts\n(message?: string)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.StopRequestError(message?)`\n- Category: `errors`\n\n## Related functions\n\n- `BeforeRequestMiddleware`\n- `z.request`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Skip empty search\n\n```ts\nif (!request.params.q) throw new z.errors.StopRequestError('no query');\n```", "usage": "throw new z.errors.StopRequestError(message?)", "signature": "throw new z.errors.StopRequestError(message?)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Skip empty search", "code": "if (!request.params.q) throw new z.errors.StopRequestError('no query');"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["BeforeRequestMiddleware", "z.request"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": null, "internals": "Short-circuits the HTTP stack. Used when middleware decides the call should not go out."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:z.errors.dehydrateerror", "kind": "core_function", "key": "z.errors.DehydrateError", "title": "z.errors.DehydrateError — Hydration pointer failed", "summary": "Bad dehydrate token or hydrator threw.", "body": "# `z.errors.DehydrateError`\n\n> Bad dehydrate token or hydrator threw.\n\n## High-level description\n\nBad dehydrate token or hydrator threw.\n\n## Internals\n\nRuntime-raised when a hydrate pointer cannot be resolved.\n\n## Typed inputs\n\n```ts\n(message?: string)\n```\n\n## Outputs\n\n```ts\nnever\n```\n\n- Signature: `throw new z.errors.DehydrateError(message?)`\n- Category: `errors`\n\n## Related functions\n\n- `z.dehydrate`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n_see signature_", "usage": "throw new z.errors.DehydrateError(message?)", "signature": "throw new z.errors.DehydrateError(message?)", "aliases": [], "flags": [], "args": [], "examples": [], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "errors", "zapier-platform-core"], "related": ["z.dehydrate"], "meta": {"surface": "platform_core", "category": "errors", "mcp_twin": null, "sdk_twin": null, "internals": "Runtime-raised when a hydrate pointer cannot be resolved."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:createapptester", "kind": "core_function", "key": "createAppTester", "title": "createAppTester — Unit-test a perform or request template", "summary": "From zapier-platform-core. Invokes a perform with a partial bundle.", "body": "# `createAppTester`\n\n> From zapier-platform-core. Invokes a perform with a partial bundle.\n\n## High-level description\n\nFrom zapier-platform-core. Invokes a perform with a partial bundle.\n\n## Internals\n\nBuilds a local z + bundle, runs the same execute path as production (minus some hook/file limits). Used by `zapier-platform test`.\n\n## Typed inputs\n\n```ts\n(appRaw: object, options?: { customStoreKey?: string }) => AppTester\n```\n\n## Outputs\n\n```ts\n(func | Request, bundle?: DeepPartial<Bundle>) => Promise<T>\n```\n\n- Signature: `createAppTester(appRaw, options?) → (func|request, bundle?) => Promise`\n- Category: `testing`\n\n## Related functions\n\n- `zapier.tools.env.inject`\n- `zapier-platform test`\n- `zapier-platform invoke`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Jest\n\n```ts\nconst tester = createAppTester(App);\nconst rows = await tester(App.triggers.new_contact.operation.perform, {\n authData: { api_key: process.env.API_KEY },\n inputData: {},\n});\n```", "usage": "createAppTester(appRaw, options?) → (func|request, bundle?) => Promise", "signature": "createAppTester(appRaw, options?) → (func|request, bundle?) => Promise", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Jest", "code": "const tester = createAppTester(App);\nconst rows = await tester(App.triggers.new_contact.operation.perform, {\n authData: { api_key: process.env.API_KEY },\n inputData: {},\n});"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "testing", "zapier-platform-core"], "related": ["zapier.tools.env.inject", "zapier-platform test", "zapier-platform invoke"], "meta": {"surface": "platform_core", "category": "testing", "mcp_twin": null, "sdk_twin": null, "internals": "Builds a local z + bundle, runs the same execute path as production (minus some hook/file limits). Used by `zapier-platform test`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:zapier.tools.env.inject", "kind": "core_function", "key": "zapier.tools.env.inject", "title": "zapier.tools.env.inject — Load .env into process.env", "summary": "Called automatically by the test runner. Useful in custom setup.", "body": "# `zapier.tools.env.inject`\n\n> Called automatically by the test runner. Useful in custom setup.\n\n## High-level description\n\nCalled automatically by the test runner. Useful in custom setup.\n\n## Internals\n\nParses KEY=VAL lines. Auth fields for invoke live as authData_* in .env.\n\n## Typed inputs\n\n```ts\n(filename?: string) => void\n```\n\n## Outputs\n\n```ts\nvoid\n```\n\n- Signature: `zapier.tools.env.inject(filename?)`\n- Category: `testing`\n\n## Related functions\n\n- `createAppTester`\n- `zapier-platform invoke`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Manual\n\n```ts\nrequire('zapier-platform-core').tools.env.inject();\n```", "usage": "zapier.tools.env.inject(filename?)", "signature": "zapier.tools.env.inject(filename?)", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Manual", "code": "require('zapier-platform-core').tools.env.inject();"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "testing", "zapier-platform-core"], "related": ["createAppTester", "zapier-platform invoke"], "meta": {"surface": "platform_core", "category": "testing", "mcp_twin": null, "sdk_twin": null, "internals": "Parses KEY=VAL lines. Auth fields for invoke live as authData_* in .env."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:beforerequestmiddleware", "kind": "core_function", "key": "BeforeRequestMiddleware", "title": "BeforeRequestMiddleware — Mutate every outbound z.request", "summary": "App.beforeRequest. Typical: attach Bearer from bundle.authData.", "body": "# `BeforeRequestMiddleware`\n\n> App.beforeRequest. Typical: attach Bearer from bundle.authData.\n\n## High-level description\n\nApp.beforeRequest. Typical: attach Bearer from bundle.authData.\n\n## Internals\n\nRuns in order before fetch. Must return the request object (with url).\n\n## Typed inputs\n\n```ts\n(request: HttpRequestOptions & { url: string }, z: ZObject, bundle: Bundle) => request | Promise<request>\n```\n\n## Outputs\n\n```ts\nHttpRequestOptions & { url: string }\n```\n\n- Signature: `(request, z, bundle) => request | Promise<request>`\n- Category: `middleware`\n\n## Related functions\n\n- `AfterResponseMiddleware`\n- `z.request`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Bearer\n\n```ts\nconst addAuth = (req, z, bundle) => {\n req.headers = req.headers || {};\n req.headers.Authorization = `Bearer ${bundle.authData.access_token}`;\n return req;\n};\nmodule.exports = { beforeRequest: [addAuth] };\n```", "usage": "(request, z, bundle) => request | Promise<request>", "signature": "(request, z, bundle) => request | Promise<request>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Bearer", "code": "const addAuth = (req, z, bundle) => {\n req.headers = req.headers || {};\n req.headers.Authorization = `Bearer ${bundle.authData.access_token}`;\n return req;\n};\nmodule.exports = { beforeRequest: [addAuth] };"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "middleware", "zapier-platform-core"], "related": ["AfterResponseMiddleware", "z.request"], "meta": {"surface": "platform_core", "category": "middleware", "mcp_twin": null, "sdk_twin": null, "internals": "Runs in order before fetch. Must return the request object (with url)."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:afterresponsemiddleware", "kind": "core_function", "key": "AfterResponseMiddleware", "title": "AfterResponseMiddleware — Inspect every HTTP response", "summary": "App.afterResponse. Throw RefreshAuthError on 401; remap error envelopes.", "body": "# `AfterResponseMiddleware`\n\n> App.afterResponse. Throw RefreshAuthError on 401; remap error envelopes.\n\n## High-level description\n\nApp.afterResponse. Throw RefreshAuthError on 401; remap error envelopes.\n\n## Internals\n\nRuns after fetch, before the perform sees the response. Can mutate response.data.\n\n## Typed inputs\n\n```ts\n(response: HttpResponse, z: ZObject, bundle: Bundle) => response | Promise<response>\n```\n\n## Outputs\n\n```ts\nHttpResponse\n```\n\n- Signature: `(response, z, bundle) => response | Promise<response>`\n- Category: `middleware`\n\n## Related functions\n\n- `BeforeRequestMiddleware`\n- `z.errors.RefreshAuthError`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### 401 → refresh\n\n```ts\nconst maybeRefresh = (resp, z) => {\n if (resp.status === 401) throw new z.errors.RefreshAuthError();\n return resp;\n};\n```", "usage": "(response, z, bundle) => response | Promise<response>", "signature": "(response, z, bundle) => response | Promise<response>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "401 → refresh", "code": "const maybeRefresh = (resp, z) => {\n if (resp.status === 401) throw new z.errors.RefreshAuthError();\n return resp;\n};"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "middleware", "zapier-platform-core"], "related": ["BeforeRequestMiddleware", "z.errors.RefreshAuthError"], "meta": {"surface": "platform_core", "category": "middleware", "mcp_twin": null, "sdk_twin": null, "internals": "Runs after fetch, before the perform sees the response. Can mutate response.data."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:pollingtriggerperform", "kind": "core_function", "key": "PollingTriggerPerform", "title": "PollingTriggerPerform — Polling trigger perform", "summary": "Must return an array of objects with id (or primary output fields).", "body": "# `PollingTriggerPerform`\n\n> Must return an array of objects with id (or primary output fields).\n\n## High-level description\n\nMust return an array of objects with id (or primary output fields).\n\n## Internals\n\nZapier dedupes by id. Newest-first recommended. meta.isPopulatingDedupe / isLoadingSample / isFillingDynamicDropdown change how many you should fetch.\n\n## Typed inputs\n\n```ts\n(z: ZObject, bundle: Bundle) => object[] | Promise<object[]>\n```\n\n## Outputs\n\n```ts\nArray<{ id: string } & Record<string, unknown>>\n```\n\n- Signature: `(z, bundle) => object[] | Promise<object[]>`\n- Category: `perform`\n\n## Related functions\n\n- `z.cursor.get`\n- `z.request`\n- `TriggerSchema`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `list-triggers / create-trigger-inbox`\n\n## Examples\n\n### List contacts\n\n```ts\nconst r = await z.request('https://api.example.com/contacts');\nreturn r.data.map((c) => ({ id: c.id, name: c.name }));\n```", "usage": "(z, bundle) => object[] | Promise<object[]>", "signature": "(z, bundle) => object[] | Promise<object[]>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "List contacts", "code": "const r = await z.request('https://api.example.com/contacts');\nreturn r.data.map((c) => ({ id: c.id, name: c.name }));"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "perform", "zapier-platform-core"], "related": ["z.cursor.get", "z.request", "TriggerSchema"], "meta": {"surface": "platform_core", "category": "perform", "mcp_twin": null, "sdk_twin": "list-triggers / create-trigger-inbox", "internals": "Zapier dedupes by id. Newest-first recommended. meta.isPopulatingDedupe / isLoadingSample / isFillingDynamicDropdown change how many you should fetch."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:webhooktriggerperform", "kind": "core_function", "key": "WebhookTriggerPerform", "title": "WebhookTriggerPerform — REST Hook perform", "summary": "Parse bundle.cleanedRequest into an array of objects.", "body": "# `WebhookTriggerPerform`\n\n> Parse bundle.cleanedRequest into an array of objects.\n\n## High-level description\n\nParse bundle.cleanedRequest into an array of objects.\n\n## Internals\n\nAlso implement performSubscribe / performUnsubscribe / performList. subscribe stores bundle.subscribeData; unsubscribe uses it. targetUrl is the Zapier hook URL to register with the partner.\n\n## Typed inputs\n\n```ts\n(z: ZObject, bundle: Bundle) => object[] | Promise<object[]>\n```\n\n## Outputs\n\n```ts\nobject[]\n```\n\n- Signature: `(z, bundle) => object[] | Promise<object[]>`\n- Category: `perform`\n\n## Related functions\n\n- `WebhookTriggerPerformSubscribe`\n- `BasicHookOperationSchema`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `create-trigger-inbox (hosted subscription)`\n\n## Examples\n\n### Unwrap\n\n```ts\nconst evt = bundle.cleanedRequest;\nreturn [{ id: evt.id, ...evt.data }];\n```", "usage": "(z, bundle) => object[] | Promise<object[]>", "signature": "(z, bundle) => object[] | Promise<object[]>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Unwrap", "code": "const evt = bundle.cleanedRequest;\nreturn [{ id: evt.id, ...evt.data }];"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "perform", "zapier-platform-core"], "related": ["WebhookTriggerPerformSubscribe", "BasicHookOperationSchema"], "meta": {"surface": "platform_core", "category": "perform", "mcp_twin": null, "sdk_twin": "create-trigger-inbox (hosted subscription)", "internals": "Also implement performSubscribe / performUnsubscribe / performList. subscribe stores bundle.subscribeData; unsubscribe uses it. targetUrl is the Zapier hook URL to register with the partner."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:createperform", "kind": "core_function", "key": "CreatePerform", "title": "CreatePerform — Create action perform", "summary": "Must return one object, not an array.", "body": "# `CreatePerform`\n\n> Must return one object, not an array.\n\n## High-level description\n\nMust return one object, not an array.\n\n## Internals\n\nReturning a non-object fails 'non-object from create'. Use performResume + z.generateCallbackUrl for long jobs. performBuffer for bulk.\n\n## Typed inputs\n\n```ts\n(z: ZObject, bundle: Bundle) => object | Promise<object>\n```\n\n## Outputs\n\n```ts\nobject\n```\n\n- Signature: `(z, bundle) => object | Promise<object>`\n- Category: `perform`\n\n## Related functions\n\n- `z.request`\n- `z.generateCallbackUrl`\n- `performBuffer`\n\n## Twins (MCP / SDK)\n\n- MCP: `execute_zapier_write_action`\n- SDK: `run-action <app> write <key>`\n\n## Examples\n\n### Create contact\n\n```ts\nconst r = await z.request({ url: '.../contacts', method: 'POST', json: bundle.inputData });\nreturn r.data;\n```", "usage": "(z, bundle) => object | Promise<object>", "signature": "(z, bundle) => object | Promise<object>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Create contact", "code": "const r = await z.request({ url: '.../contacts', method: 'POST', json: bundle.inputData });\nreturn r.data;"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "perform", "zapier-platform-core"], "related": ["z.request", "z.generateCallbackUrl", "performBuffer"], "meta": {"surface": "platform_core", "category": "perform", "mcp_twin": "execute_zapier_write_action", "sdk_twin": "run-action <app> write <key>", "internals": "Returning a non-object fails 'non-object from create'. Use performResume + z.generateCallbackUrl for long jobs. performBuffer for bulk."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:searchperform", "kind": "core_function", "key": "SearchPerform", "title": "SearchPerform — Search action perform", "summary": "Must return an array (possibly empty). Empty = not found (needed for search-or-create).", "body": "# `SearchPerform`\n\n> Must return an array (possibly empty). Empty = not found (needed for search-or-create).\n\n## High-level description\n\nMust return an array (possibly empty). Empty = not found (needed for search-or-create).\n\n## Internals\n\nMay return { results, paging_token } envelope. meta.paging_token continues a previous page.\n\n## Typed inputs\n\n```ts\n(z: ZObject, bundle: Bundle) => object[] | Promise<object[]>\n```\n\n## Outputs\n\n```ts\nobject[] | { results: object[]; paging_token?: string }\n```\n\n- Signature: `(z, bundle) => object[] | Promise<object[]>`\n- Category: `perform`\n\n## Related functions\n\n- `CreatePerform`\n- `SearchOrCreateSchema`\n\n## Twins (MCP / SDK)\n\n- MCP: `execute_zapier_read_action`\n- SDK: `run-action <app> search <key>`\n\n## Examples\n\n### Find by email\n\n```ts\nconst r = await z.request({ url: '.../contacts', params: { email: bundle.inputData.email } });\nreturn r.data.items || [];\n```", "usage": "(z, bundle) => object[] | Promise<object[]>", "signature": "(z, bundle) => object[] | Promise<object[]>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Find by email", "code": "const r = await z.request({ url: '.../contacts', params: { email: bundle.inputData.email } });\nreturn r.data.items || [];"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "perform", "zapier-platform-core"], "related": ["CreatePerform", "SearchOrCreateSchema"], "meta": {"surface": "platform_core", "category": "perform", "mcp_twin": "execute_zapier_read_action", "sdk_twin": "run-action <app> search <key>", "internals": "May return { results, paging_token } envelope. meta.paging_token continues a previous page."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "core_function:performbuffer", "kind": "core_function", "key": "performBuffer", "title": "performBuffer — Buffered / bulk create", "summary": "Process bundle.buffer items in one API call. Return a map keyed by each item's meta.id.", "body": "# `performBuffer`\n\n> Process bundle.buffer items in one API call. Return a map keyed by each item's meta.id.\n\n## High-level description\n\nProcess bundle.buffer items in one API call. Return a map keyed by each item's meta.id.\n\n## Internals\n\nZapier groups creates and sends them together. Each result must be success (outputData) or error string.\n\n## Typed inputs\n\n```ts\n(z: ZObject, bundle: { authData; buffer: { inputData; meta: { id: string } }[]; groupedBy }) => Promise<PerformBufferResult>\n```\n\n## Outputs\n\n```ts\nRecord<string, { outputData?: object; error?: string }>\n```\n\n- Signature: `(z, BufferedBundle) => Promise<{[id]: {outputData?, error?}}>`\n- Category: `perform`\n\n## Related functions\n\n- `CreatePerform`\n\n## Twins (MCP / SDK)\n\n- MCP: `—`\n- SDK: `—`\n\n## Examples\n\n### Bulk insert\n\n```ts\nconst created = await postAll(bundle.buffer.map((i) => i.inputData));\nreturn Object.fromEntries(bundle.buffer.map((i, n) => [i.meta.id, { outputData: created[n] }]));\n```", "usage": "(z, BufferedBundle) => Promise<{[id]: {outputData?, error?}}>", "signature": "(z, BufferedBundle) => Promise<{[id]: {outputData?, error?}}>", "aliases": [], "flags": [], "args": [], "examples": [{"title": "Bulk insert", "code": "const created = await postAll(bundle.buffer.map((i) => i.inputData));\nreturn Object.fromEntries(bundle.buffer.map((i, n) => [i.meta.id, { outputData: created[n] }]));"}], "source_url": "https://docs.zapier.com/integrations/build-cli/core", "source_repo": "zapier/zapier-platform", "source_path": "packages/core/types/custom.d.ts", "section": "platform-core", "tags": ["core", "function", "perform", "zapier-platform-core"], "related": ["CreatePerform"], "meta": {"surface": "platform_core", "category": "perform", "mcp_twin": null, "sdk_twin": null, "internals": "Zapier groups creates and sends them together. Each result must be success (outputData) or error string."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:analytics", "kind": "cli_function", "key": "analytics", "title": "zapier-platform analytics", "summary": "Show the status of the analytics that are collected. Also used to change what is collected.", "body": "# `analytics`\n\n> Show the status of the analytics that are collected. Also used to change what is collected.\n\n## High-level description\n\nShow the status of the analytics that are collected. Also used to change what is collected.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n m, __mode?: string | boolean; // `-m, --mode` | Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifyin\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform analytics __mode enabled?: string | boolean; // `zapier-platform analytics --mode enabled`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform analytics`\n- Aliases: `zapier analytics`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier analytics`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Show the status of the analytics that are collected. Also used to change what is collected.\n\n**Usage**: `zapier-platform analytics`\n\n**Flags**\n* `-m, --mode` | Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifying information is used only for debugging purposes. One of `[enabled | anonymous | disabled]`.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform analytics --mode enabled`\n\n## Examples\n\n```bash\n-m, --mode\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform analytics --mode enabled\n```", "usage": "zapier-platform analytics", "signature": "zapier-platform analytics", "aliases": ["zapier analytics"], "flags": ["`-m, --mode` | Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifying information is used only for debugging purposes. One of `[enabled | anonymous | disabled]`.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform analytics --mode enabled`"], "args": [], "examples": ["-m, --mode", "-d, --debug", "zapier-platform analytics --mode enabled"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "analytics"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:analytics", "kind": "cli_command", "key": "analytics", "title": "zapier-platform analytics", "summary": "Show the status of the analytics that are collected. Also used to change what is collected.", "body": "# `analytics`\n\n> Show the status of the analytics that are collected. Also used to change what is collected.\n\n## High-level description\n\nShow the status of the analytics that are collected. Also used to change what is collected.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n m, __mode?: string | boolean; // `-m, --mode` | Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifyin\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform analytics __mode enabled?: string | boolean; // `zapier-platform analytics --mode enabled`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform analytics`\n- Aliases: `zapier analytics`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier analytics`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Show the status of the analytics that are collected. Also used to change what is collected.\n\n**Usage**: `zapier-platform analytics`\n\n**Flags**\n* `-m, --mode` | Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifying information is used only for debugging purposes. One of `[enabled | anonymous | disabled]`.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform analytics --mode enabled`\n\n## Examples\n\n```bash\n-m, --mode\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform analytics --mode enabled\n```", "usage": "zapier-platform analytics", "signature": "zapier-platform analytics", "aliases": ["zapier analytics"], "flags": ["`-m, --mode` | Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifying information is used only for debugging purposes. One of `[enabled | anonymous | disabled]`.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform analytics --mode enabled`"], "args": [], "examples": ["-m, --mode", "-d, --debug", "zapier-platform analytics --mode enabled"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "analytics"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:build", "kind": "cli_function", "key": "build", "title": "zapier-platform build", "summary": "Build a pushable zip from the current directory.", "body": "# `build`\n\n> Build a pushable zip from the current directory.\n\n## High-level description\n\nBuild a pushable zip from the current directory.\n\n## Internals\n\nTemp copy → zapierwrapper.js entry → esbuild dep detection → build/build.zip + source.zip.\n\n## Typed inputs\n\n```ts\ntype Input = {\n zapierwrapper.js?: string | boolean; // Adds an entry point: `zapierwrapper.js`\n .js?: string | boolean; // Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to y\n build/build.zip?: string | boolean; // Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n disable_dependency_detection?: string | boolean; // `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry po\n skip_dep_install?: string | boolean; // `--skip-dep-install` | [alias: --skip-npm-install]\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform build`\n- Aliases: `zapier build`\n\n## Related functions\n\n- `build`\n- `upload`\n- `push`\n- `validate`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier build`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Build a pushable zip from the current directory.\n\n**Usage**: `zapier-platform build`\n\nThis command does the following:\n\n* Creates a temporary folder\n* Copies all code into the temporary folder\n* Adds an entry point: `zapierwrapper.js`\n* Generates and validates app definition.\n* Detects dependencies via esbuild (optional, on by default)\n* Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.\n* Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n\nThis command is typically followed by `zapier-platform upload`.\n\n**Flags**\n* `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.\n* `--skip-dep-install` | [alias: --skip-npm-install]\nSkips installing a fresh copy of dependencies for shorter build time. Helpful for using yarn, pnpm, or local copies of dependencies.\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n--disable-dependency-detection\n```\n```bash\n--skip-dep-install\n```\n```bash\n-d, --debug\n```", "usage": "zapier-platform build", "signature": "zapier-platform build", "aliases": ["zapier build"], "flags": ["Adds an entry point: `zapierwrapper.js`", "Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.", "Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder", "`--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.", "`--skip-dep-install` | [alias: --skip-npm-install]", "`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["--disable-dependency-detection", "--skip-dep-install", "-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "build"], "related": ["build", "upload", "push", "validate"], "meta": {"surface": "platform_cli", "internals": "Temp copy → zapierwrapper.js entry → esbuild dep detection → build/build.zip + source.zip."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:build", "kind": "cli_command", "key": "build", "title": "zapier-platform build", "summary": "Build a pushable zip from the current directory.", "body": "# `build`\n\n> Build a pushable zip from the current directory.\n\n## High-level description\n\nBuild a pushable zip from the current directory.\n\n## Internals\n\nTemp copy → zapierwrapper.js entry → esbuild dep detection → build/build.zip + source.zip.\n\n## Typed inputs\n\n```ts\ntype Input = {\n zapierwrapper.js?: string | boolean; // Adds an entry point: `zapierwrapper.js`\n .js?: string | boolean; // Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to y\n build/build.zip?: string | boolean; // Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n disable_dependency_detection?: string | boolean; // `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry po\n skip_dep_install?: string | boolean; // `--skip-dep-install` | [alias: --skip-npm-install]\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform build`\n- Aliases: `zapier build`\n\n## Related functions\n\n- `build`\n- `upload`\n- `push`\n- `validate`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier build`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Build a pushable zip from the current directory.\n\n**Usage**: `zapier-platform build`\n\nThis command does the following:\n\n* Creates a temporary folder\n* Copies all code into the temporary folder\n* Adds an entry point: `zapierwrapper.js`\n* Generates and validates app definition.\n* Detects dependencies via esbuild (optional, on by default)\n* Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.\n* Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n\nThis command is typically followed by `zapier-platform upload`.\n\n**Flags**\n* `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.\n* `--skip-dep-install` | [alias: --skip-npm-install]\nSkips installing a fresh copy of dependencies for shorter build time. Helpful for using yarn, pnpm, or local copies of dependencies.\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n--disable-dependency-detection\n```\n```bash\n--skip-dep-install\n```\n```bash\n-d, --debug\n```", "usage": "zapier-platform build", "signature": "zapier-platform build", "aliases": ["zapier build"], "flags": ["Adds an entry point: `zapierwrapper.js`", "Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.", "Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder", "`--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.", "`--skip-dep-install` | [alias: --skip-npm-install]", "`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["--disable-dependency-detection", "--skip-dep-install", "-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "build"], "related": ["build", "upload", "push", "validate"], "meta": {"surface": "platform_cli", "internals": "Temp copy → zapierwrapper.js entry → esbuild dep detection → build/build.zip + source.zip."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:canary:create", "kind": "cli_function", "key": "canary:create", "title": "zapier-platform canary:create", "summary": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.", "body": "# `canary:create`\n\n> Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\n## High-level description\n\nCreate a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\n## Internals\n\nTemporary traffic split FROM→TO for duration seconds. Reverts when expired.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Version to route traffic from\n required: string; // Version to canary traffic to\n versionFrom?: string | boolean; // (required) `versionFrom` | Version to route traffic from\n versionTo?: string | boolean; // (required) `versionTo` | Version to canary traffic to\n p, __percent?: string | boolean; // (required) `-p, --percent` | Percent of traffic to route to new version\n d, __duration?: string | boolean; // (required) `-d, --duration` | Duration of the canary in seconds\n u, __user?: string | boolean; // `-u, --user` | Canary this user (email) across all accounts, unless `account-id` is specified.\n a, __account_id?: string | boolean; // `-a, --account-id` | The account ID to target. If user is specified, only canary the user within this account. If user is not specified, the\n f, __force_include_all?: string | boolean; // `-f, --force-include-all` | Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform canary:create 1.0.0 1.1.0 _p 10 _d 3600?: string | boolean; // `zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600`\n zapier_platform canary:create 2.0.0 2.1.0 __percent 25 __duration 1800 __user user@example.com?: string | boolean; // `zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com`\n zapier_platform canary:create 2.0.0 2.1.0 _p 15 _d 7200 _a 12345 _u user@example.com?: string | boolean; // `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com`\n zapier_platform canary:create 2.0.0 2.1.0 _p 15 _d 7200 _a 12345?: string | boolean; // `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform canary:create VERSIONFROM VERSIONTO`\n- Aliases: `zapier canary:create`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier canary:create`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\n**Usage**: `zapier-platform canary:create VERSIONFROM VERSIONTO`\n\nOnly one canary can be active at the same time. You can run `zapier-platform canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier-platform canary:delete a.b.c x.y.z`.\n\nTo canary traffic for a specific user, use the --user flag.\n\nTo canary traffic for an entire account, use the --account-id. Note: this scenario is only permitted for Zapier staff.\n\nTo canary traffic for a specific user within a specific account, use both --user and --account-id flags.\n\nNote: this is similar to `zapier-platform migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**\n\n**Arguments**\n* (required) `versionFrom` | Version to route traffic from\n* (required) `versionTo` | Version to canary traffic to\n\n**Flags**\n* (required) `-p, --percent` | Percent of traffic to route to new version\n* (required) `-d, --duration` | Duration of the canary in seconds\n* `-u, --user` | Canary this user (email) across all accounts, unless `account-id` is specified.\n* `-a, --account-id` | The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.\n* `-f, --force-include-all` | Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600`\n* `zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com`\n* `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com`\n* `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345`\n\n## Examples\n\n```bash\n-u, --user\n```\n```bash\n-a, --account-id\n```\n```bash\n-f, --force-include-all\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600\n```\n```bash\nzapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com\n```\n```bash\nzapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com\n```\n```bash\nzapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345\n```", "usage": "zapier-platform canary:create VERSIONFROM VERSIONTO", "signature": "zapier-platform canary:create VERSIONFROM VERSIONTO", "aliases": ["zapier canary:create"], "flags": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version to canary traffic to", "(required) `-p, --percent` | Percent of traffic to route to new version", "(required) `-d, --duration` | Duration of the canary in seconds", "`-u, --user` | Canary this user (email) across all accounts, unless `account-id` is specified.", "`-a, --account-id` | The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.", "`-f, --force-include-all` | Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600`", "`zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com`", "`zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com`", "`zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345`"], "args": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version to canary traffic to"], "examples": ["-u, --user", "-a, --account-id", "-f, --force-include-all", "-d, --debug", "zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600", "zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com", "zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com", "zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "canary"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Temporary traffic split FROM→TO for duration seconds. Reverts when expired."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:canary:create", "kind": "cli_command", "key": "canary:create", "title": "zapier-platform canary:create", "summary": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.", "body": "# `canary:create`\n\n> Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\n## High-level description\n\nCreate a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\n## Internals\n\nTemporary traffic split FROM→TO for duration seconds. Reverts when expired.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Version to route traffic from\n required: string; // Version to canary traffic to\n versionFrom?: string | boolean; // (required) `versionFrom` | Version to route traffic from\n versionTo?: string | boolean; // (required) `versionTo` | Version to canary traffic to\n p, __percent?: string | boolean; // (required) `-p, --percent` | Percent of traffic to route to new version\n d, __duration?: string | boolean; // (required) `-d, --duration` | Duration of the canary in seconds\n u, __user?: string | boolean; // `-u, --user` | Canary this user (email) across all accounts, unless `account-id` is specified.\n a, __account_id?: string | boolean; // `-a, --account-id` | The account ID to target. If user is specified, only canary the user within this account. If user is not specified, the\n f, __force_include_all?: string | boolean; // `-f, --force-include-all` | Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform canary:create 1.0.0 1.1.0 _p 10 _d 3600?: string | boolean; // `zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600`\n zapier_platform canary:create 2.0.0 2.1.0 __percent 25 __duration 1800 __user user@example.com?: string | boolean; // `zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com`\n zapier_platform canary:create 2.0.0 2.1.0 _p 15 _d 7200 _a 12345 _u user@example.com?: string | boolean; // `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com`\n zapier_platform canary:create 2.0.0 2.1.0 _p 15 _d 7200 _a 12345?: string | boolean; // `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform canary:create VERSIONFROM VERSIONTO`\n- Aliases: `zapier canary:create`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier canary:create`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\n**Usage**: `zapier-platform canary:create VERSIONFROM VERSIONTO`\n\nOnly one canary can be active at the same time. You can run `zapier-platform canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier-platform canary:delete a.b.c x.y.z`.\n\nTo canary traffic for a specific user, use the --user flag.\n\nTo canary traffic for an entire account, use the --account-id. Note: this scenario is only permitted for Zapier staff.\n\nTo canary traffic for a specific user within a specific account, use both --user and --account-id flags.\n\nNote: this is similar to `zapier-platform migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**\n\n**Arguments**\n* (required) `versionFrom` | Version to route traffic from\n* (required) `versionTo` | Version to canary traffic to\n\n**Flags**\n* (required) `-p, --percent` | Percent of traffic to route to new version\n* (required) `-d, --duration` | Duration of the canary in seconds\n* `-u, --user` | Canary this user (email) across all accounts, unless `account-id` is specified.\n* `-a, --account-id` | The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.\n* `-f, --force-include-all` | Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600`\n* `zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com`\n* `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com`\n* `zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345`\n\n## Examples\n\n```bash\n-u, --user\n```\n```bash\n-a, --account-id\n```\n```bash\n-f, --force-include-all\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600\n```\n```bash\nzapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com\n```\n```bash\nzapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com\n```\n```bash\nzapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345\n```", "usage": "zapier-platform canary:create VERSIONFROM VERSIONTO", "signature": "zapier-platform canary:create VERSIONFROM VERSIONTO", "aliases": ["zapier canary:create"], "flags": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version to canary traffic to", "(required) `-p, --percent` | Percent of traffic to route to new version", "(required) `-d, --duration` | Duration of the canary in seconds", "`-u, --user` | Canary this user (email) across all accounts, unless `account-id` is specified.", "`-a, --account-id` | The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.", "`-f, --force-include-all` | Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600`", "`zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com`", "`zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com`", "`zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345`"], "args": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version to canary traffic to"], "examples": ["-u, --user", "-a, --account-id", "-f, --force-include-all", "-d, --debug", "zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600", "zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com", "zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com", "zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "canary"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Temporary traffic split FROM→TO for duration seconds. Reverts when expired."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:canary:delete", "kind": "cli_function", "key": "canary:delete", "title": "zapier-platform canary:delete", "summary": "Delete an active canary deployment", "body": "# `canary:delete`\n\n> Delete an active canary deployment\n\n## High-level description\n\nDelete an active canary deployment\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Version to route traffic from\n required: string; // Version canary traffic is routed to\n versionFrom?: string | boolean; // (required) `versionFrom` | Version to route traffic from\n versionTo?: string | boolean; // (required) `versionTo` | Version canary traffic is routed to\n zapier_platform canary:delete 1.0.0 1.1.0?: string | boolean; // `zapier-platform canary:delete 1.0.0 1.1.0`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform canary:delete VERSIONFROM VERSIONTO`\n- Aliases: `zapier canary:delete`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier canary:delete`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Delete an active canary deployment\n\n**Usage**: `zapier-platform canary:delete VERSIONFROM VERSIONTO`\n\n**Arguments**\n* (required) `versionFrom` | Version to route traffic from\n* (required) `versionTo` | Version canary traffic is routed to\n\n**Examples**\n* `zapier-platform canary:delete 1.0.0 1.1.0`\n\n## Examples\n\n```bash\nzapier-platform canary:delete 1.0.0 1.1.0\n```", "usage": "zapier-platform canary:delete VERSIONFROM VERSIONTO", "signature": "zapier-platform canary:delete VERSIONFROM VERSIONTO", "aliases": ["zapier canary:delete"], "flags": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version canary traffic is routed to", "`zapier-platform canary:delete 1.0.0 1.1.0`"], "args": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version canary traffic is routed to"], "examples": ["zapier-platform canary:delete 1.0.0 1.1.0"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "canary"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:canary:delete", "kind": "cli_command", "key": "canary:delete", "title": "zapier-platform canary:delete", "summary": "Delete an active canary deployment", "body": "# `canary:delete`\n\n> Delete an active canary deployment\n\n## High-level description\n\nDelete an active canary deployment\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Version to route traffic from\n required: string; // Version canary traffic is routed to\n versionFrom?: string | boolean; // (required) `versionFrom` | Version to route traffic from\n versionTo?: string | boolean; // (required) `versionTo` | Version canary traffic is routed to\n zapier_platform canary:delete 1.0.0 1.1.0?: string | boolean; // `zapier-platform canary:delete 1.0.0 1.1.0`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform canary:delete VERSIONFROM VERSIONTO`\n- Aliases: `zapier canary:delete`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier canary:delete`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Delete an active canary deployment\n\n**Usage**: `zapier-platform canary:delete VERSIONFROM VERSIONTO`\n\n**Arguments**\n* (required) `versionFrom` | Version to route traffic from\n* (required) `versionTo` | Version canary traffic is routed to\n\n**Examples**\n* `zapier-platform canary:delete 1.0.0 1.1.0`\n\n## Examples\n\n```bash\nzapier-platform canary:delete 1.0.0 1.1.0\n```", "usage": "zapier-platform canary:delete VERSIONFROM VERSIONTO", "signature": "zapier-platform canary:delete VERSIONFROM VERSIONTO", "aliases": ["zapier canary:delete"], "flags": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version canary traffic is routed to", "`zapier-platform canary:delete 1.0.0 1.1.0`"], "args": ["(required) `versionFrom` | Version to route traffic from", "(required) `versionTo` | Version canary traffic is routed to"], "examples": ["zapier-platform canary:delete 1.0.0 1.1.0"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "canary"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:canary:list", "kind": "cli_function", "key": "canary:list", "title": "zapier-platform canary:list", "summary": "List all active canary deployments", "body": "# `canary:list`\n\n> List all active canary deployments\n\n## High-level description\n\nList all active canary deployments\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform canary:list?: string | boolean; // `zapier-platform canary:list`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform canary:list`\n- Aliases: `zapier canary:list`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier canary:list`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> List all active canary deployments\n\n**Usage**: `zapier-platform canary:list`\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform canary:list`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform canary:list\n```", "usage": "zapier-platform canary:list", "signature": "zapier-platform canary:list", "aliases": ["zapier canary:list"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform canary:list`"], "args": [], "examples": ["-d, --debug", "-f, --format", "zapier-platform canary:list"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "canary"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:canary:list", "kind": "cli_command", "key": "canary:list", "title": "zapier-platform canary:list", "summary": "List all active canary deployments", "body": "# `canary:list`\n\n> List all active canary deployments\n\n## High-level description\n\nList all active canary deployments\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform canary:list?: string | boolean; // `zapier-platform canary:list`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform canary:list`\n- Aliases: `zapier canary:list`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier canary:list`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> List all active canary deployments\n\n**Usage**: `zapier-platform canary:list`\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform canary:list`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform canary:list\n```", "usage": "zapier-platform canary:list", "signature": "zapier-platform canary:list", "aliases": ["zapier canary:list"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform canary:list`"], "args": [], "examples": ["-d, --debug", "-f, --format", "zapier-platform canary:list"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "canary"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:convert", "kind": "cli_function", "key": "convert", "title": "zapier-platform convert", "summary": "Convert a Visual Builder integration to a CLI integration.", "body": "# `convert`\n\n> Convert a Visual Builder integration to a CLI integration.\n\n## High-level description\n\nConvert a Visual Builder integration to a CLI integration.\n\n## Internals\n\nDownloads a Visual Builder definition (or --json) and emits CLI source. Existing files are not clobbered.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Relative to your current path - IE: `.` for current directory.\n path?: string | boolean; // (required) `path` | Relative to your current path - IE: `.` for current directory.\n i, __integrationId?: string | boolean; // `-i, --integrationId` | To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number di\n v, __version?: string | boolean; // `-v, --version` | Convert a specific version. Required when converting a Visual Builder integration.\n j, __json?: string | boolean; // `-j, --json` | The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The \n t, __title?: string | boolean; // `-t, --title` | The integration title, which will be snake-cased for the package.json name.\n d, __description?: string | boolean; // `-d, --description` | The integration description, which will be used for the package.json description.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform convert PATH`\n- Aliases: `zapier convert`\n\n## Related functions\n\n- `init`\n- `scaffold`\n- `convert`\n- `register`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier convert`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Convert a Visual Builder integration to a CLI integration.\n\n**Usage**: `zapier-platform convert PATH`\n\nThe resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!\n\nIf you re-run this command on an existing directory it will leave existing files alone and not clobber them.\n\nYou'll need to do a `zapier-platform push` before the new version is visible in the editor, but otherwise you're good to go.\n\n**Arguments**\n* (required) `path` | Relative to your current path - IE: `.` for current directory.\n\n**Flags**\n* `-i, --integrationId` | To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number directly after \"/app/\" in the URL.\n* `-v, --version` | Convert a specific version. Required when converting a Visual Builder integration.\n* `-j, --json` | The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.\n* `-t, --title` | The integration title, which will be snake-cased for the package.json name.\n* `-d, --description` | The integration description, which will be used for the package.json description.\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-i, --integrationId\n```\n```bash\n-v, --version\n```\n```bash\n-j, --json\n```\n```bash\n-t, --title\n```\n```bash\n-d, --description\n```\n```bash\n-d, --debug\n```", "usage": "zapier-platform convert PATH", "signature": "zapier-platform convert PATH", "aliases": ["zapier convert"], "flags": ["(required) `path` | Relative to your current path - IE: `.` for current directory.", "`-i, --integrationId` | To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number directly after \"/app/\" in the URL.", "`-v, --version` | Convert a specific version. Required when converting a Visual Builder integration.", "`-j, --json` | The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.", "`-t, --title` | The integration title, which will be snake-cased for the package.json name.", "`-d, --description` | The integration description, which will be used for the package.json description.", "`-d, --debug` | Show extra debugging output."], "args": ["(required) `path` | Relative to your current path - IE: `.` for current directory."], "examples": ["-i, --integrationId", "-v, --version", "-j, --json", "-t, --title", "-d, --description", "-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "convert"], "related": ["init", "scaffold", "convert", "register"], "meta": {"surface": "platform_cli", "internals": "Downloads a Visual Builder definition (or --json) and emits CLI source. Existing files are not clobbered."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:convert", "kind": "cli_command", "key": "convert", "title": "zapier-platform convert", "summary": "Convert a Visual Builder integration to a CLI integration.", "body": "# `convert`\n\n> Convert a Visual Builder integration to a CLI integration.\n\n## High-level description\n\nConvert a Visual Builder integration to a CLI integration.\n\n## Internals\n\nDownloads a Visual Builder definition (or --json) and emits CLI source. Existing files are not clobbered.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Relative to your current path - IE: `.` for current directory.\n path?: string | boolean; // (required) `path` | Relative to your current path - IE: `.` for current directory.\n i, __integrationId?: string | boolean; // `-i, --integrationId` | To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number di\n v, __version?: string | boolean; // `-v, --version` | Convert a specific version. Required when converting a Visual Builder integration.\n j, __json?: string | boolean; // `-j, --json` | The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The \n t, __title?: string | boolean; // `-t, --title` | The integration title, which will be snake-cased for the package.json name.\n d, __description?: string | boolean; // `-d, --description` | The integration description, which will be used for the package.json description.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform convert PATH`\n- Aliases: `zapier convert`\n\n## Related functions\n\n- `init`\n- `scaffold`\n- `convert`\n- `register`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier convert`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Convert a Visual Builder integration to a CLI integration.\n\n**Usage**: `zapier-platform convert PATH`\n\nThe resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!\n\nIf you re-run this command on an existing directory it will leave existing files alone and not clobber them.\n\nYou'll need to do a `zapier-platform push` before the new version is visible in the editor, but otherwise you're good to go.\n\n**Arguments**\n* (required) `path` | Relative to your current path - IE: `.` for current directory.\n\n**Flags**\n* `-i, --integrationId` | To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number directly after \"/app/\" in the URL.\n* `-v, --version` | Convert a specific version. Required when converting a Visual Builder integration.\n* `-j, --json` | The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.\n* `-t, --title` | The integration title, which will be snake-cased for the package.json name.\n* `-d, --description` | The integration description, which will be used for the package.json description.\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-i, --integrationId\n```\n```bash\n-v, --version\n```\n```bash\n-j, --json\n```\n```bash\n-t, --title\n```\n```bash\n-d, --description\n```\n```bash\n-d, --debug\n```", "usage": "zapier-platform convert PATH", "signature": "zapier-platform convert PATH", "aliases": ["zapier convert"], "flags": ["(required) `path` | Relative to your current path - IE: `.` for current directory.", "`-i, --integrationId` | To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number directly after \"/app/\" in the URL.", "`-v, --version` | Convert a specific version. Required when converting a Visual Builder integration.", "`-j, --json` | The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.", "`-t, --title` | The integration title, which will be snake-cased for the package.json name.", "`-d, --description` | The integration description, which will be used for the package.json description.", "`-d, --debug` | Show extra debugging output."], "args": ["(required) `path` | Relative to your current path - IE: `.` for current directory."], "examples": ["-i, --integrationId", "-v, --version", "-j, --json", "-t, --title", "-d, --description", "-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "convert"], "related": ["init", "scaffold", "convert", "register"], "meta": {"surface": "platform_cli", "internals": "Downloads a Visual Builder definition (or --json) and emits CLI source. Existing files are not clobbered."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:delete:integration", "kind": "cli_function", "key": "delete:integration", "title": "zapier-platform delete:integration", "summary": "Delete your integration (including all versions).", "body": "# `delete:integration`\n\n> Delete your integration (including all versions).\n\n## High-level description\n\nDelete your integration (including all versions).\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n delete:app?: string | boolean; // `delete:app`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform delete:integration`\n- Aliases: `delete:app`, `zapier delete:integration`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier delete:integration`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Delete your integration (including all versions).\n\n**Usage**: `zapier-platform delete:integration`\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier-platform delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n**Aliases**\n* `delete:app`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\ndelete:app\n```", "usage": "zapier-platform delete:integration", "signature": "zapier-platform delete:integration", "aliases": ["delete:app", "zapier delete:integration"], "flags": ["`-d, --debug` | Show extra debugging output.", "`delete:app`"], "args": [], "examples": ["-d, --debug", "delete:app"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "delete"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:delete:integration", "kind": "cli_command", "key": "delete:integration", "title": "zapier-platform delete:integration", "summary": "Delete your integration (including all versions).", "body": "# `delete:integration`\n\n> Delete your integration (including all versions).\n\n## High-level description\n\nDelete your integration (including all versions).\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n delete:app?: string | boolean; // `delete:app`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform delete:integration`\n- Aliases: `delete:app`, `zapier delete:integration`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier delete:integration`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Delete your integration (including all versions).\n\n**Usage**: `zapier-platform delete:integration`\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier-platform delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n**Aliases**\n* `delete:app`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\ndelete:app\n```", "usage": "zapier-platform delete:integration", "signature": "zapier-platform delete:integration", "aliases": ["delete:app", "zapier delete:integration"], "flags": ["`-d, --debug` | Show extra debugging output.", "`delete:app`"], "args": [], "examples": ["-d, --debug", "delete:app"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "delete"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:delete:version", "kind": "cli_function", "key": "delete:version", "title": "zapier-platform delete:version", "summary": "Delete a specific version of your integration.", "body": "# `delete:version`\n\n> Delete a specific version of your integration.\n\n## High-level description\n\nDelete a specific version of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Specify the version to delete. It must have no users or Zaps.\n version?: string | boolean; // (required) `version` | Specify the version to delete. It must have no users or Zaps.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform delete:version VERSION`\n- Aliases: `zapier delete:version`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier delete:version`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Delete a specific version of your integration.\n\n**Usage**: `zapier-platform delete:version VERSION`\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier-platform migrate` and `zapier-platform deprecate` before this command will work.\n\n**Arguments**\n* (required) `version` | Specify the version to delete. It must have no users or Zaps.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform delete:version VERSION", "signature": "zapier-platform delete:version VERSION", "aliases": ["zapier delete:version"], "flags": ["(required) `version` | Specify the version to delete. It must have no users or Zaps.", "`-d, --debug` | Show extra debugging output."], "args": ["(required) `version` | Specify the version to delete. It must have no users or Zaps."], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "delete"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:delete:version", "kind": "cli_command", "key": "delete:version", "title": "zapier-platform delete:version", "summary": "Delete a specific version of your integration.", "body": "# `delete:version`\n\n> Delete a specific version of your integration.\n\n## High-level description\n\nDelete a specific version of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Specify the version to delete. It must have no users or Zaps.\n version?: string | boolean; // (required) `version` | Specify the version to delete. It must have no users or Zaps.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform delete:version VERSION`\n- Aliases: `zapier delete:version`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier delete:version`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Delete a specific version of your integration.\n\n**Usage**: `zapier-platform delete:version VERSION`\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier-platform migrate` and `zapier-platform deprecate` before this command will work.\n\n**Arguments**\n* (required) `version` | Specify the version to delete. It must have no users or Zaps.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform delete:version VERSION", "signature": "zapier-platform delete:version VERSION", "aliases": ["zapier delete:version"], "flags": ["(required) `version` | Specify the version to delete. It must have no users or Zaps.", "`-d, --debug` | Show extra debugging output."], "args": ["(required) `version` | Specify the version to delete. It must have no users or Zaps."], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "delete"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:deprecate", "kind": "cli_function", "key": "deprecate", "title": "zapier-platform deprecate", "summary": "Mark a non-production version of your integration as deprecated, with removal by a certain date.", "body": "# `deprecate`\n\n> Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\n## High-level description\n\nMark a non-production version of your integration as deprecated, with removal by a certain date.\n\n## Internals\n\nSchedules removal (DATE ≥ 3 weeks). Users emailed at T-14d.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to deprecate.\n required: string; // The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.\n version?: string | boolean; // (required) `version` | The version to deprecate.\n date?: string | boolean; // (required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.\n f, __force?: string | boolean; // `-f, --force` | Skip confirmation prompt. Use with caution.\n r, __reason?: string | boolean; // `-r, --reason` | Reason for deprecation. One of `[api endpoint deprecated | security vulnerability | critical bug | legal requirement | othe\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform deprecate 1.2.3 2011_10_01?: string | boolean; // `zapier-platform deprecate 1.2.3 2011-10-01`\n zapier_platform deprecate 1.2.3 2011_10_01 __reason=security_vulnerability?: string | boolean; // `zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability`\n zapier_platform deprecate 1.2.3 2011_10_01 _r critical_bug?: string | boolean; // `zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform deprecate VERSION DATE`\n- Aliases: `zapier deprecate`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier deprecate`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\n**Usage**: `zapier-platform deprecate VERSION DATE`\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nWhen deprecating a version, you must provide a reason for the deprecation. You can either specify the reason using the --reason flag or you will be prompted to select from the following options:\n- API endpoint deprecated\n- Security vulnerability\n- Critical bug\n- Legal requirement\n- Other\n\nThe deprecation date must be at least 3 weeks days in the future. Zapier will send emails warning users of the deprecation exactly 14 days before the configured deprecation date. This gives you 1 week to migrate users to a newer version, if possible, before we notify them that they need to do so themselves.\n\nThere are other side effects: they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nDo not use deprecation if you only have non-breaking changes, such as:\n- Fixing help text\n- Adding new triggers/actions\n- Improving existing functionality\n- other bug fixes that don't break existing automations.\n\n**Arguments**\n* (required) `version` | The version to deprecate.\n* (required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.\n\n**Flags**\n* `-f, --force` | Skip confirmation prompt. Use with caution.\n* `-r, --reason` | Reason for deprecation. One of `[api endpoint deprecated | security vulnerability | critical bug | legal requirement | other]`.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform deprecate 1.2.3 2011-10-01`\n* `zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability`\n* `zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug`\n\n## Examples\n\n```bash\n-f, --force\n```\n```bash\n-r, --reason\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform deprecate 1.2.3 2011-10-01\n```\n```bash\nzapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability\n```\n```bash\nzapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug\n```", "usage": "zapier-platform deprecate VERSION DATE", "signature": "zapier-platform deprecate VERSION DATE", "aliases": ["zapier deprecate"], "flags": ["(required) `version` | The version to deprecate.", "(required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.", "`-f, --force` | Skip confirmation prompt. Use with caution.", "`-r, --reason` | Reason for deprecation. One of `[api endpoint deprecated | security vulnerability | critical bug | legal requirement | other]`.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform deprecate 1.2.3 2011-10-01`", "`zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability`", "`zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug`"], "args": ["(required) `version` | The version to deprecate.", "(required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable."], "examples": ["-f, --force", "-r, --reason", "-d, --debug", "zapier-platform deprecate 1.2.3 2011-10-01", "zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability", "zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "deprecate"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Schedules removal (DATE ≥ 3 weeks). Users emailed at T-14d."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:deprecate", "kind": "cli_command", "key": "deprecate", "title": "zapier-platform deprecate", "summary": "Mark a non-production version of your integration as deprecated, with removal by a certain date.", "body": "# `deprecate`\n\n> Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\n## High-level description\n\nMark a non-production version of your integration as deprecated, with removal by a certain date.\n\n## Internals\n\nSchedules removal (DATE ≥ 3 weeks). Users emailed at T-14d.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to deprecate.\n required: string; // The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.\n version?: string | boolean; // (required) `version` | The version to deprecate.\n date?: string | boolean; // (required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.\n f, __force?: string | boolean; // `-f, --force` | Skip confirmation prompt. Use with caution.\n r, __reason?: string | boolean; // `-r, --reason` | Reason for deprecation. One of `[api endpoint deprecated | security vulnerability | critical bug | legal requirement | othe\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform deprecate 1.2.3 2011_10_01?: string | boolean; // `zapier-platform deprecate 1.2.3 2011-10-01`\n zapier_platform deprecate 1.2.3 2011_10_01 __reason=security_vulnerability?: string | boolean; // `zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability`\n zapier_platform deprecate 1.2.3 2011_10_01 _r critical_bug?: string | boolean; // `zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform deprecate VERSION DATE`\n- Aliases: `zapier deprecate`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier deprecate`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\n**Usage**: `zapier-platform deprecate VERSION DATE`\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nWhen deprecating a version, you must provide a reason for the deprecation. You can either specify the reason using the --reason flag or you will be prompted to select from the following options:\n- API endpoint deprecated\n- Security vulnerability\n- Critical bug\n- Legal requirement\n- Other\n\nThe deprecation date must be at least 3 weeks days in the future. Zapier will send emails warning users of the deprecation exactly 14 days before the configured deprecation date. This gives you 1 week to migrate users to a newer version, if possible, before we notify them that they need to do so themselves.\n\nThere are other side effects: they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nDo not use deprecation if you only have non-breaking changes, such as:\n- Fixing help text\n- Adding new triggers/actions\n- Improving existing functionality\n- other bug fixes that don't break existing automations.\n\n**Arguments**\n* (required) `version` | The version to deprecate.\n* (required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.\n\n**Flags**\n* `-f, --force` | Skip confirmation prompt. Use with caution.\n* `-r, --reason` | Reason for deprecation. One of `[api endpoint deprecated | security vulnerability | critical bug | legal requirement | other]`.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform deprecate 1.2.3 2011-10-01`\n* `zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability`\n* `zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug`\n\n## Examples\n\n```bash\n-f, --force\n```\n```bash\n-r, --reason\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform deprecate 1.2.3 2011-10-01\n```\n```bash\nzapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability\n```\n```bash\nzapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug\n```", "usage": "zapier-platform deprecate VERSION DATE", "signature": "zapier-platform deprecate VERSION DATE", "aliases": ["zapier deprecate"], "flags": ["(required) `version` | The version to deprecate.", "(required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.", "`-f, --force` | Skip confirmation prompt. Use with caution.", "`-r, --reason` | Reason for deprecation. One of `[api endpoint deprecated | security vulnerability | critical bug | legal requirement | other]`.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform deprecate 1.2.3 2011-10-01`", "`zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability`", "`zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug`"], "args": ["(required) `version` | The version to deprecate.", "(required) `date` | The date (YYYY-MM-DD) when Zapier will make the specified version unavailable."], "examples": ["-f, --force", "-r, --reason", "-d, --debug", "zapier-platform deprecate 1.2.3 2011-10-01", "zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability", "zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "deprecate"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Schedules removal (DATE ≥ 3 weeks). Users emailed at T-14d."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:describe", "kind": "cli_function", "key": "describe", "title": "zapier-platform describe", "summary": "Describe the current integration.", "body": "# `describe`\n\n> Describe the current integration.\n\n## High-level description\n\nDescribe the current integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform describe`\n- Aliases: `zapier describe`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier describe`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Describe the current integration.\n\n**Usage**: `zapier-platform describe`\n\nThis command prints a human readable enumeration of your integrations's\ntriggers, searches, and creates as seen by Zapier. Useful to understand how your\nresources convert and relate to different actions.\n\n* **Noun**: your action's noun\n* **Label**: your action's label\n* **Resource**: the resource (if any) this action is tied to\n* **Available Methods**: testable methods for this action\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform describe", "signature": "zapier-platform describe", "aliases": ["zapier describe"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "describe"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:describe", "kind": "cli_command", "key": "describe", "title": "zapier-platform describe", "summary": "Describe the current integration.", "body": "# `describe`\n\n> Describe the current integration.\n\n## High-level description\n\nDescribe the current integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform describe`\n- Aliases: `zapier describe`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier describe`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Describe the current integration.\n\n**Usage**: `zapier-platform describe`\n\nThis command prints a human readable enumeration of your integrations's\ntriggers, searches, and creates as seen by Zapier. Useful to understand how your\nresources convert and relate to different actions.\n\n* **Noun**: your action's noun\n* **Label**: your action's label\n* **Resource**: the resource (if any) this action is tied to\n* **Available Methods**: testable methods for this action\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform describe", "signature": "zapier-platform describe", "aliases": ["zapier describe"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "describe"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:env:get", "kind": "cli_function", "key": "env:get", "title": "zapier-platform env:get", "summary": "Get environment variables for a version.", "body": "# `env:get`\n\n> Get environment variables for a version.\n\n## High-level description\n\nGet environment variables for a version.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to get the environment for.\n version?: string | boolean; // (required) `version` | The version to get the environment for.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform env:get 1.2.3?: string | boolean; // `zapier-platform env:get 1.2.3`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform env:get VERSION`\n- Aliases: `zapier env:get`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier env:get`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get environment variables for a version.\n\n**Usage**: `zapier-platform env:get VERSION`\n\n**Arguments**\n* (required) `version` | The version to get the environment for.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform env:get 1.2.3`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform env:get 1.2.3\n```", "usage": "zapier-platform env:get VERSION", "signature": "zapier-platform env:get VERSION", "aliases": ["zapier env:get"], "flags": ["(required) `version` | The version to get the environment for.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform env:get 1.2.3`"], "args": ["(required) `version` | The version to get the environment for."], "examples": ["-d, --debug", "-f, --format", "zapier-platform env:get 1.2.3"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "env"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:env:get", "kind": "cli_command", "key": "env:get", "title": "zapier-platform env:get", "summary": "Get environment variables for a version.", "body": "# `env:get`\n\n> Get environment variables for a version.\n\n## High-level description\n\nGet environment variables for a version.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to get the environment for.\n version?: string | boolean; // (required) `version` | The version to get the environment for.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform env:get 1.2.3?: string | boolean; // `zapier-platform env:get 1.2.3`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform env:get VERSION`\n- Aliases: `zapier env:get`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier env:get`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get environment variables for a version.\n\n**Usage**: `zapier-platform env:get VERSION`\n\n**Arguments**\n* (required) `version` | The version to get the environment for.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform env:get 1.2.3`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform env:get 1.2.3\n```", "usage": "zapier-platform env:get VERSION", "signature": "zapier-platform env:get VERSION", "aliases": ["zapier env:get"], "flags": ["(required) `version` | The version to get the environment for.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform env:get 1.2.3`"], "args": ["(required) `version` | The version to get the environment for."], "examples": ["-d, --debug", "-f, --format", "zapier-platform env:get 1.2.3"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "env"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:env:set", "kind": "cli_function", "key": "env:set", "title": "zapier-platform env:set", "summary": "Set environment variables for a version.", "body": "# `env:set`\n\n> Set environment variables for a version.\n\n## High-level description\n\nSet environment variables for a version.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the \n key-value?: string; // The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For exam\n version?: string | boolean; // (required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command wil\n key_value pairs...?: string | boolean; // `key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separa\n f, __force?: string | boolean; // `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform env:set 1.2.3 SECRET=12345 OTHER=4321?: string | boolean; // `zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform env:set VERSION [KEY-VALUE PAIRS...]`\n- Aliases: `zapier env:set`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier env:set`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Set environment variables for a version.\n\n**Usage**: `zapier-platform env:set VERSION [KEY-VALUE PAIRS...]`\n\n**Arguments**\n* (required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.\n* `key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`\n\n**Flags**\n* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321`\n\n## Examples\n\n```bash\nkey-value pairs...\n```\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321\n```", "usage": "zapier-platform env:set VERSION [KEY-VALUE PAIRS...]", "signature": "zapier-platform env:set VERSION [KEY-VALUE PAIRS...]", "aliases": ["zapier env:set"], "flags": ["(required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.", "`key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`", "`-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321`"], "args": ["(required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.", "`key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`"], "examples": ["key-value pairs...", "-f, --force", "-d, --debug", "zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "env"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:env:set", "kind": "cli_command", "key": "env:set", "title": "zapier-platform env:set", "summary": "Set environment variables for a version.", "body": "# `env:set`\n\n> Set environment variables for a version.\n\n## High-level description\n\nSet environment variables for a version.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the \n key-value?: string; // The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For exam\n version?: string | boolean; // (required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command wil\n key_value pairs...?: string | boolean; // `key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separa\n f, __force?: string | boolean; // `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform env:set 1.2.3 SECRET=12345 OTHER=4321?: string | boolean; // `zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform env:set VERSION [KEY-VALUE PAIRS...]`\n- Aliases: `zapier env:set`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier env:set`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Set environment variables for a version.\n\n**Usage**: `zapier-platform env:set VERSION [KEY-VALUE PAIRS...]`\n\n**Arguments**\n* (required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.\n* `key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`\n\n**Flags**\n* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321`\n\n## Examples\n\n```bash\nkey-value pairs...\n```\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321\n```", "usage": "zapier-platform env:set VERSION [KEY-VALUE PAIRS...]", "signature": "zapier-platform env:set VERSION [KEY-VALUE PAIRS...]", "aliases": ["zapier env:set"], "flags": ["(required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.", "`key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`", "`-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321`"], "args": ["(required) `version` | The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.", "`key-value pairs...` | The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`"], "examples": ["key-value pairs...", "-f, --force", "-d, --debug", "zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "env"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:env:unset", "kind": "cli_function", "key": "env:unset", "title": "zapier-platform env:unset", "summary": "Unset environment variables for a version.", "body": "# `env:unset`\n\n> Unset environment variables for a version.\n\n## High-level description\n\nUnset environment variables for a version.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to set the environment for.\n keys...?: string; // The keys to unset. Keys are case-insensitive.\n version?: string | boolean; // (required) `version` | The version to set the environment for.\n keys...?: string | boolean; // `keys...` | The keys to unset. Keys are case-insensitive.\n f, __force?: string | boolean; // `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform env:unset 1.2.3 SECRET OTHER?: string | boolean; // `zapier-platform env:unset 1.2.3 SECRET OTHER`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform env:unset VERSION [KEYS...]`\n- Aliases: `zapier env:unset`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier env:unset`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Unset environment variables for a version.\n\n**Usage**: `zapier-platform env:unset VERSION [KEYS...]`\n\n**Arguments**\n* (required) `version` | The version to set the environment for.\n* `keys...` | The keys to unset. Keys are case-insensitive.\n\n**Flags**\n* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform env:unset 1.2.3 SECRET OTHER`\n\n## Examples\n\n```bash\nkeys...\n```\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform env:unset 1.2.3 SECRET OTHER\n```", "usage": "zapier-platform env:unset VERSION [KEYS...]", "signature": "zapier-platform env:unset VERSION [KEYS...]", "aliases": ["zapier env:unset"], "flags": ["(required) `version` | The version to set the environment for.", "`keys...` | The keys to unset. Keys are case-insensitive.", "`-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform env:unset 1.2.3 SECRET OTHER`"], "args": ["(required) `version` | The version to set the environment for.", "`keys...` | The keys to unset. Keys are case-insensitive."], "examples": ["keys...", "-f, --force", "-d, --debug", "zapier-platform env:unset 1.2.3 SECRET OTHER"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "env"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:env:unset", "kind": "cli_command", "key": "env:unset", "title": "zapier-platform env:unset", "summary": "Unset environment variables for a version.", "body": "# `env:unset`\n\n> Unset environment variables for a version.\n\n## High-level description\n\nUnset environment variables for a version.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to set the environment for.\n keys...?: string; // The keys to unset. Keys are case-insensitive.\n version?: string | boolean; // (required) `version` | The version to set the environment for.\n keys...?: string | boolean; // `keys...` | The keys to unset. Keys are case-insensitive.\n f, __force?: string | boolean; // `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform env:unset 1.2.3 SECRET OTHER?: string | boolean; // `zapier-platform env:unset 1.2.3 SECRET OTHER`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform env:unset VERSION [KEYS...]`\n- Aliases: `zapier env:unset`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier env:unset`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Unset environment variables for a version.\n\n**Usage**: `zapier-platform env:unset VERSION [KEYS...]`\n\n**Arguments**\n* (required) `version` | The version to set the environment for.\n* `keys...` | The keys to unset. Keys are case-insensitive.\n\n**Flags**\n* `-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform env:unset 1.2.3 SECRET OTHER`\n\n## Examples\n\n```bash\nkeys...\n```\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform env:unset 1.2.3 SECRET OTHER\n```", "usage": "zapier-platform env:unset VERSION [KEYS...]", "signature": "zapier-platform env:unset VERSION [KEYS...]", "aliases": ["zapier env:unset"], "flags": ["(required) `version` | The version to set the environment for.", "`keys...` | The keys to unset. Keys are case-insensitive.", "`-f, --force` | Force the update of environment variables regardless if the app version is production or not. Use with caution.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform env:unset 1.2.3 SECRET OTHER`"], "args": ["(required) `version` | The version to set the environment for.", "`keys...` | The keys to unset. Keys are case-insensitive."], "examples": ["keys...", "-f, --force", "-d, --debug", "zapier-platform env:unset 1.2.3 SECRET OTHER"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "env"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:history", "kind": "cli_function", "key": "history", "title": "zapier-platform history", "summary": "Get the history of your integration.", "body": "# `history`\n\n> Get the history of your integration.\n\n## High-level description\n\nGet the history of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform history`\n- Aliases: `zapier history`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier history`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get the history of your integration.\n\n**Usage**: `zapier-platform history`\n\nHistory includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform history", "signature": "zapier-platform history", "aliases": ["zapier history"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "history"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:history", "kind": "cli_command", "key": "history", "title": "zapier-platform history", "summary": "Get the history of your integration.", "body": "# `history`\n\n> Get the history of your integration.\n\n## High-level description\n\nGet the history of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform history`\n- Aliases: `zapier history`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier history`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get the history of your integration.\n\n**Usage**: `zapier-platform history`\n\nHistory includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform history", "signature": "zapier-platform history", "aliases": ["zapier history"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "history"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:init", "kind": "cli_function", "key": "init", "title": "zapier-platform init", "summary": "Initialize a new Zapier integration with a project template.", "body": "# `init`\n\n> Initialize a new Zapier integration with a project template.\n\n## High-level description\n\nInitialize a new Zapier integration with a project template.\n\n## Internals\n\nCopies an official example-apps template (oauth2, session-auth, …) into PATH. Does not call Zapier until register/push.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirm\n path?: string | boolean; // (required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, w\n t, __template?: string | boolean; // `-t, --template` | The template to start your integration with. One of `[basic-auth | callback | custom-auth | digest-auth | dynamic-dropdow\n m, __module?: string | boolean; // `-m, --module` | Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates. One of `[commonjs | esm]`.\n l, __language?: string | boolean; // `-l, --language` | Choose the language to use for your new integration. Defaults to JavaScript. One of `[javascript | typescript]`.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform init myapp?: string | boolean; // `zapier-platform init myapp`\n zapier_platform init ./path/myapp __template oauth2?: string | boolean; // `zapier-platform init ./path/myapp --template oauth2`\n zapier_platform init ./path/myapp __template minimal __module esm?: string | boolean; // `zapier-platform init ./path/myapp --template minimal --module esm`\n zapier_platform init ./path/myapp __template oauth2 __language typescript?: string | boolean; // `zapier-platform init ./path/myapp --template oauth2 --language typescript`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform init PATH`\n- Aliases: `zapier init`\n\n## Related functions\n\n- `init`\n- `scaffold`\n- `convert`\n- `register`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier init`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Initialize a new Zapier integration with a project template.\n\n**Usage**: `zapier-platform init PATH`\n\nAfter running this, you'll have a new integration in the specified directory. If you re-run this command on an existing directory, it will prompt before overwriting any existing files.\n\nThis doesn't register or deploy the integration with Zapier - try the `zapier-platform register` and `zapier-platform push` commands for that!\n\n**Arguments**\n* (required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation\n\n**Flags**\n* `-t, --template` | The template to start your integration with. One of `[basic-auth | callback | custom-auth | digest-auth | dynamic-dropdown | files | line-items | minimal | oauth1-trello | oauth2 | openai | search-or-create | session-auth]`.\n* `-m, --module` | Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates. One of `[commonjs | esm]`.\n* `-l, --language` | Choose the language to use for your new integration. Defaults to JavaScript. One of `[javascript | typescript]`.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform init myapp`\n* `zapier-platform init ./path/myapp --template oauth2`\n* `zapier-platform init ./path/myapp --template minimal --module esm`\n* `zapier-platform init ./path/myapp --template oauth2 --language typescript`\n\n## Examples\n\n```bash\n-t, --template\n```\n```bash\n-m, --module\n```\n```bash\n-l, --language\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform init myapp\n```\n```bash\nzapier-platform init ./path/myapp --template oauth2\n```\n```bash\nzapier-platform init ./path/myapp --template minimal --module esm\n```\n```bash\nzapier-platform init ./path/myapp --template oauth2 --language typescript\n```", "usage": "zapier-platform init PATH", "signature": "zapier-platform init PATH", "aliases": ["zapier init"], "flags": ["(required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation", "`-t, --template` | The template to start your integration with. One of `[basic-auth | callback | custom-auth | digest-auth | dynamic-dropdown | files | line-items | minimal | oauth1-trello | oauth2 | openai | search-or-create | session-auth]`.", "`-m, --module` | Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates. One of `[commonjs | esm]`.", "`-l, --language` | Choose the language to use for your new integration. Defaults to JavaScript. One of `[javascript | typescript]`.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform init myapp`", "`zapier-platform init ./path/myapp --template oauth2`", "`zapier-platform init ./path/myapp --template minimal --module esm`", "`zapier-platform init ./path/myapp --template oauth2 --language typescript`"], "args": ["(required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation"], "examples": ["-t, --template", "-m, --module", "-l, --language", "-d, --debug", "zapier-platform init myapp", "zapier-platform init ./path/myapp --template oauth2", "zapier-platform init ./path/myapp --template minimal --module esm", "zapier-platform init ./path/myapp --template oauth2 --language typescript"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "init"], "related": ["init", "scaffold", "convert", "register"], "meta": {"surface": "platform_cli", "internals": "Copies an official example-apps template (oauth2, session-auth, …) into PATH. Does not call Zapier until register/push."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:init", "kind": "cli_command", "key": "init", "title": "zapier-platform init", "summary": "Initialize a new Zapier integration with a project template.", "body": "# `init`\n\n> Initialize a new Zapier integration with a project template.\n\n## High-level description\n\nInitialize a new Zapier integration with a project template.\n\n## Internals\n\nCopies an official example-apps template (oauth2, session-auth, …) into PATH. Does not call Zapier until register/push.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirm\n path?: string | boolean; // (required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, w\n t, __template?: string | boolean; // `-t, --template` | The template to start your integration with. One of `[basic-auth | callback | custom-auth | digest-auth | dynamic-dropdow\n m, __module?: string | boolean; // `-m, --module` | Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates. One of `[commonjs | esm]`.\n l, __language?: string | boolean; // `-l, --language` | Choose the language to use for your new integration. Defaults to JavaScript. One of `[javascript | typescript]`.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform init myapp?: string | boolean; // `zapier-platform init myapp`\n zapier_platform init ./path/myapp __template oauth2?: string | boolean; // `zapier-platform init ./path/myapp --template oauth2`\n zapier_platform init ./path/myapp __template minimal __module esm?: string | boolean; // `zapier-platform init ./path/myapp --template minimal --module esm`\n zapier_platform init ./path/myapp __template oauth2 __language typescript?: string | boolean; // `zapier-platform init ./path/myapp --template oauth2 --language typescript`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform init PATH`\n- Aliases: `zapier init`\n\n## Related functions\n\n- `init`\n- `scaffold`\n- `convert`\n- `register`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier init`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Initialize a new Zapier integration with a project template.\n\n**Usage**: `zapier-platform init PATH`\n\nAfter running this, you'll have a new integration in the specified directory. If you re-run this command on an existing directory, it will prompt before overwriting any existing files.\n\nThis doesn't register or deploy the integration with Zapier - try the `zapier-platform register` and `zapier-platform push` commands for that!\n\n**Arguments**\n* (required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation\n\n**Flags**\n* `-t, --template` | The template to start your integration with. One of `[basic-auth | callback | custom-auth | digest-auth | dynamic-dropdown | files | line-items | minimal | oauth1-trello | oauth2 | openai | search-or-create | session-auth]`.\n* `-m, --module` | Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates. One of `[commonjs | esm]`.\n* `-l, --language` | Choose the language to use for your new integration. Defaults to JavaScript. One of `[javascript | typescript]`.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform init myapp`\n* `zapier-platform init ./path/myapp --template oauth2`\n* `zapier-platform init ./path/myapp --template minimal --module esm`\n* `zapier-platform init ./path/myapp --template oauth2 --language typescript`\n\n## Examples\n\n```bash\n-t, --template\n```\n```bash\n-m, --module\n```\n```bash\n-l, --language\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform init myapp\n```\n```bash\nzapier-platform init ./path/myapp --template oauth2\n```\n```bash\nzapier-platform init ./path/myapp --template minimal --module esm\n```\n```bash\nzapier-platform init ./path/myapp --template oauth2 --language typescript\n```", "usage": "zapier-platform init PATH", "signature": "zapier-platform init PATH", "aliases": ["zapier init"], "flags": ["(required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation", "`-t, --template` | The template to start your integration with. One of `[basic-auth | callback | custom-auth | digest-auth | dynamic-dropdown | files | line-items | minimal | oauth1-trello | oauth2 | openai | search-or-create | session-auth]`.", "`-m, --module` | Choose module type: CommonJS or ES Modules. Only enabled for Typescript and Minimal templates. One of `[commonjs | esm]`.", "`-l, --language` | Choose the language to use for your new integration. Defaults to JavaScript. One of `[javascript | typescript]`.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform init myapp`", "`zapier-platform init ./path/myapp --template oauth2`", "`zapier-platform init ./path/myapp --template minimal --module esm`", "`zapier-platform init ./path/myapp --template oauth2 --language typescript`"], "args": ["(required) `path` | Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation"], "examples": ["-t, --template", "-m, --module", "-l, --language", "-d, --debug", "zapier-platform init myapp", "zapier-platform init ./path/myapp --template oauth2", "zapier-platform init ./path/myapp --template minimal --module esm", "zapier-platform init ./path/myapp --template oauth2 --language typescript"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "init"], "related": ["init", "scaffold", "convert", "register"], "meta": {"surface": "platform_cli", "internals": "Copies an official example-apps template (oauth2, session-auth, …) into PATH. Does not call Zapier until register/push."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:integrations", "kind": "cli_function", "key": "integrations", "title": "zapier-platform integrations", "summary": "List integrations you have admin access to.", "body": "# `integrations`\n\n> List integrations you have admin access to.\n\n## High-level description\n\nList integrations you have admin access to.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n apps?: string | boolean; // `apps`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform integrations`\n- Aliases: `apps`, `zapier integrations`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier integrations`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> List integrations you have admin access to.\n\n**Usage**: `zapier-platform integrations`\n\nThis command also checks the current directory for a linked integration.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Aliases**\n* `apps`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\napps\n```", "usage": "zapier-platform integrations", "signature": "zapier-platform integrations", "aliases": ["apps", "zapier integrations"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`apps`"], "args": [], "examples": ["-d, --debug", "-f, --format", "apps"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "integrations"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:integrations", "kind": "cli_command", "key": "integrations", "title": "zapier-platform integrations", "summary": "List integrations you have admin access to.", "body": "# `integrations`\n\n> List integrations you have admin access to.\n\n## High-level description\n\nList integrations you have admin access to.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n apps?: string | boolean; // `apps`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform integrations`\n- Aliases: `apps`, `zapier integrations`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier integrations`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> List integrations you have admin access to.\n\n**Usage**: `zapier-platform integrations`\n\nThis command also checks the current directory for a linked integration.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Aliases**\n* `apps`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\napps\n```", "usage": "zapier-platform integrations", "signature": "zapier-platform integrations", "aliases": ["apps", "zapier integrations"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`apps`"], "args": [], "examples": ["-d, --debug", "-f, --format", "apps"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "integrations"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:invoke", "kind": "cli_function", "key": "invoke", "title": "zapier-platform invoke", "summary": "Invoke an authentication method, a trigger, or a create/search action locally or remotely.", "body": "# `invoke`\n\n> Invoke an authentication method, a trigger, or a create/search action locally or remotely.\n\n## High-level description\n\nInvoke an authentication method, a trigger, or a create/search action locally or remotely.\n\n## Internals\n\nLocal (default, .env), relay (-a auth id, traffic via Zapier), or remote (-r, production). Emulates (z, bundle).\n\n## Typed inputs\n\n```ts\ntype Input = {\n actionType?: string; // The action type you want to invoke.\n actionKey?: string; // The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".\n authData?: string; // Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence ov\n VAR_NAME=VALUE?: string | boolean; // `VAR_NAME=VALUE` for environment variables\n authData_FIELD_KEY=VALUE?: string | boolean; // `authData_FIELD_KEY=VALUE` for auth data fields\n actionType?: string | boolean; // `actionType` | The action type you want to invoke.\n actionKey?: string | boolean; // `actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".\n authData?: string | boolean; // `authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take \n i, __inputData?: string | boolean; // `-i, --inputData` | The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly li\n isFillingDynamicDropdown?: string | boolean; // `--isFillingDynamicDropdown` | Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in produc\n isLoadingSample?: string | boolean; // `--isLoadingSample` | Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor \n isPopulatingDedupe?: string | boolean; // `--isPopulatingDedupe` | Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the re\n limit?: string | boolean; // `--limit` | Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fe\n p, __page?: string | boolean; // `-p, --page` | Set bundle.meta.page. Only makes sense for a trigger. When used in production, this indicates which page of items you should \n non_interactive?: string | boolean; // `--non-interactive` | Do not show interactive prompts.\n z, __timezone?: string | boolean; // `-z, --timezone` | Set the default timezone for datetime field interpretation. If not set, defaults to America/Chicago, which matches Zapier\n redirect_uri?: string | boolean; // `--redirect-uri` | Only used by `auth start` subcommand. The redirect URI that will be passed to the OAuth2 authorization URL. Usually this \n local_port?: string | boolean; // `--local-port` | Only used by `auth start` subcommand. The local port that will be used to start the local HTTP server to listen for the OAu\n r, __remote?: string | boolean; // `-r, --remote` | Run your trigger/action remotely on Zapier production servers instead of locally. This requires deploying your integration \n v, __version?: string | boolean; // `-v, --version` | Only used when `--remote` is set. Specify a deployed version to invoke instead of the one currently set in your local pack\n a, __authentication_id?: string | boolean; // `-a, --authentication-id` | EXPERIMENTAL: Instead of using the local .env file, use the production authentication data with the given authen\n paging_token?: string | boolean; // `--paging-token` | Set bundle.meta.paging_token. Used for search pagination or bulk reads. When used in production, this indicates which pag\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform invoke?: string | boolean; // `zapier-platform invoke`\n zapier_platform invoke auth start?: string | boolean; // `zapier-platform invoke auth start`\n zapier_platform invoke auth refresh?: string | boolean; // `zapier-platform invoke auth refresh`\n zapier_platform invoke auth test?: string | boolean; // `zapier-platform invoke auth test`\n zapier_platform invoke auth label?: string | boolean; // `zapier-platform invoke auth label`\n zapier_platform invoke trigger new_recipe?: string | boolean; // `zapier-platform invoke trigger new_recipe`\n zapier_platform invoke create add_recipe __inputData '{\"title\": \"Pancakes\"}'?: string | boolean; // `zapier-platform invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'`\n zapier_platform invoke search find_recipe _i @file.json __non_interactive?: string | boolean; // `zapier-platform invoke search find_recipe -i @file.json --non-interactive`\n cat file.json | zapier_platform invoke trigger new_recipe _i @_?: string | boolean; // `cat file.json | zapier-platform invoke trigger new_recipe -i @-`\n zapier_platform invoke search find_ticket __authentication_id 12345?: string | boolean; // `zapier-platform invoke search find_ticket --authentication-id 12345`\n zapier_platform invoke create add_ticket _a _?: string | boolean; // `zapier-platform invoke create add_ticket -a -`\n zapier_platform invoke trigger new_recipe __remote?: string | boolean; // `zapier-platform invoke trigger new_recipe --remote`\n zapier_platform invoke trigger new_recipe _r _a 12345?: string | boolean; // `zapier-platform invoke trigger new_recipe -r -a 12345`\n zapier_platform invoke _r _v 2.0.0 _a _?: string | boolean; // `zapier-platform invoke -r -v 2.0.0 -a -`\n zapier_platform invoke auth render '{\"access_token\":\"a_token\"}'?: string | boolean; // `zapier-platform invoke auth render '{\"access_token\":\"a_token\"}'`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]`\n- Aliases: `zapier invoke`\n\n## Related functions\n\n- `invoke`\n- `test`\n- `createAppTester`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier invoke`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Invoke an authentication method, a trigger, or a create/search action locally or remotely.\n\n**Usage**: `zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]`\n\nThis command allows you to invoke your integration's authentication, triggers, and actions. With this tool, you can test and debug your integration code directly from your terminal without leaving your development environment and opening a browser.\n\nWhy use this command?\n\n* Fast feedback loops: Verify your code changes instantly.\n* Step-by-step debugging: Use a debugger to step through your code locally.\n* Untruncated logs: View complete HTTP logs and errors in your terminal.\n\n### Modes\n\nThe `invoke` command works in three modes:\n\n1. Local mode (default): runs your code locally, and sends outgoing requests directly from your local machine.\n2. Relay mode (experimental): runs your code locally, but proxies all outgoing requests through Zapier using production authentication data.\n3. Remote mode: runs your code and sends outgoing requests entirely in/from Zapier production environment.\n\n**Local mode** is the default mode. Without the `--remote` (or `-r`) flag or the `--authentication-id` (or `-a`) flag, the command runs in local mode. It's useful when you want to quickly test your integration code locally. You'll need to set up local auth data in the `.env` file using the `zapier-platform invoke auth start` command.\n\n**Relay mode** is currently experimental. It's enabled when the `-a` flag is specified. It's useful when you want to test code locally but setting up local auth data is troublesome, such as when your OAuth2 server requires a non-localhost or HTTPS redirect URI. By specifying `-a <authentication-id>`, all outgoing requests will be proxied through Zapier's relay service using the production auth data with the given authentication ID. See the **Authentication** section below for more details.\n\nBoth local and relay mode **emulate** how your code would run in Zapier production environment, so the behavior might not be exactly the same. But we consider every inconsistency a bug or a limitation to be fixed. For 100% match with production behavior, use remote mode.\n\n**Remote mode** is enabled when the `--remote` (or `-r`) flag is specified. It's useful when you want to verify how your code behaves in Zapier production environment. Note that remote mode requires deploying your integration first. If the `-a` flag is not specified, the command will prompt you to select one of your available authentications/connections in production. By default, the remote mode invokes the `version` set in your `package.json`. You can use the `--version` (or `-v`) flag to specify a different deployed version.\n\n### Authentication\n\nYou can supply the authentcation data in two ways: Load from the local `.env` file or use the `--authentication-id` flag.\n\n#### The local `.env` file\n\nThis command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier-platform invoke auth start` command to help you initialize it, or you can manually create it.\n\nThe `zapier-platform invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.\n\nEach line in the `.env` file should follow one of these formats:\n\n* `VAR_NAME=VALUE` for environment variables\n* `authData_FIELD_KEY=VALUE` for auth data fields\n\nFor example, a `.env` file for an OAuth2 integration might look like this:\n\n```\nCLIENT_ID='your_client_id'\nCLIENT_SECRET='your_client_secret'\nauthData_access_token='1234567890'\nauthData_refresh_token='abcdefg'\nauthData_account_name='zapier'\n```\n\n\n#### The `--authentication-id` flag\n\nSetting up local auth data can be troublesome. For instance, in OAuth2, you may have to configure your app server to allow localhost redirect URIs or use a port forwarding tool. This is sometimes not easy to get right.\n\nThe `--authentication-id` flag (`-a` for short) gives you an alternative (and perhaps easier) way to supply your auth data. You can use `-a` to specify an existing production authentication/connection. The available authentications can be found at https://zapier.com/app/assets/connections. Check https://zpr.io/z8SjFTdnTFZ2 for more instructions.\n\nWhen `-a -` is specified, such as `zapier-platform invoke auth test -a -`, the command will interactively prompt you to select one of your available authentications.\n\nIf you know your authentication ID, you can specify it directly, such as `zapier-platform invoke auth test -a 123456`.\n\nThe `-a` flag also works in remote mode with the `-r` flag. In remote mode, if `-a` is not specified, such as `zapier-platform invoke -r`, the command will prompt you to select one of your available authentications.\n\n#### Testing authentication\n\nTo test if the auth data is correct, run either one of these:\n\n```\nzapier-platform invoke auth test # invokes authentication.test method\nzapier-platform invoke auth label # invokes authentication.test and renders connection label\n```\n\nTo refresh stale auth data for OAuth2 or session auth, run `zapier-platform invoke auth refresh`. Note that refreshing is only applicable for local auth data in the `.env` file.\n\n### Invoking a trigger or an action\n\nOnce you have the correct auth data, you can test an trigger, a search, or a create action. For example, here's how you invoke a trigger with the key `new_recipe`:\n\n```\nzapier-platform invoke trigger new_recipe # (local mode)\nzapier-platform invoke trigger new_recipe -r # (remote mode)\n```\n\nTo add input data, use the `--inputData` flag (`-i` for short). The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.\n\nWhen you miss any command arguments, such as ACTIONTYPE or ACTIONKEY, the command will prompt you interactively. If you don't want to get interactive prompts, use the `--non-interactive` flag.\n\nThe `--debug` flag will show you the HTTP request logs and any console logs you have in your code.\n\n### Limitations in local and relay mode\n\nThe following is a non-exhaustive list of current limitations in local and relay mode. We may support them in the future.\n\n- Hook triggers, including REST hook subscribe/unsubscribe\n- Output hydration\n- File upload\n- Function-based connection label\n- Buffered create actions\n- Search-or-create actions\n- Search-powered fields\n- autoRefresh for OAuth2 and session auth\n\n\n**Arguments**\n* `actionType` | The action type you want to invoke.\n* `actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".\n* `authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence over the .env file.\n\n**Flags**\n* `-i, --inputData` | The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.\n* `--isFillingDynamicDropdown` | Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in production, this poll is being used to populate a dynamic dropdown.\n* `--isLoadingSample` | Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor trying to pull a sample.\n* `--isPopulatingDedupe` | Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the results of this poll will be used initialize the deduplication list rather than trigger a Zap. This happens when a user enables a Zap.\n* `--limit` | Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fetch. -1 means no limit\n\n## Examples\n\n```bash\nVAR_NAME=VALUE\n```\n```bash\nauthData_FIELD_KEY=VALUE\n```\n```bash\nactionType\n```\n```bash\nactionKey\n```\n```bash\nauthData\n```\n```bash\n-i, --inputData\n```\n```bash\n--isFillingDynamicDropdown\n```\n```bash\n--isLoadingSample\n```", "usage": "zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]", "signature": "zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]", "aliases": ["zapier invoke"], "flags": ["`VAR_NAME=VALUE` for environment variables", "`authData_FIELD_KEY=VALUE` for auth data fields", "`actionType` | The action type you want to invoke.", "`actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".", "`authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence over the .env file.", "`-i, --inputData` | The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.", "`--isFillingDynamicDropdown` | Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in production, this poll is being used to populate a dynamic dropdown.", "`--isLoadingSample` | Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor trying to pull a sample.", "`--isPopulatingDedupe` | Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the results of this poll will be used initialize the deduplication list rather than trigger a Zap. This happens when a user enables a Zap.", "`--limit` | Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fetch. -1 means no limit. Defaults to `-1`.", "`-p, --page` | Set bundle.meta.page. Only makes sense for a trigger. When used in production, this indicates which page of items you should fetch. First page is 0.", "`--non-interactive` | Do not show interactive prompts.", "`-z, --timezone` | Set the default timezone for datetime field interpretation. If not set, defaults to America/Chicago, which matches Zapier production behavior. Find the list timezone names at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Defaults to `America/Chicago`.", "`--redirect-uri` | Only used by `auth start` subcommand. The redirect URI that will be passed to the OAuth2 authorization URL. Usually this should match the one configured in your server's OAuth2 application settings. A local HTTP server will be started to listen for the OAuth2 callback. If your server requires a non-localhost or HTTPS address for the redirect URI, you can set up port forwarding to route the non-localhost or HTTPS address to localhost. Defaults to `http://localhost:9000`.", "`--local-port` | Only used by `auth start` subcommand. The local port that will be used to start the local HTTP server to listen for the OAuth2 callback. This port can be different from the one in the redirect URI if you have port forwarding set up. Defaults to `9000`.", "`-r, --remote` | Run your trigger/action remotely on Zapier production servers instead of locally. This requires deploying your integration first. Because this (remote) mode uses the same set of API endpoints as the Zap editor and other Zapier products, it allows you to verify exactly how your code will behave in production. Note that `--authentication-id` is required and implied in remote mode, as a production authentication is necessary to invoke in production.", "`-v, --version` | Only used when `--remote` is set. Specify a deployed version to invoke instead of the one currently set in your local package.json.", "`-a, --authentication-id` | EXPERIMENTAL: Instead of using the local .env file, use the production authentication data with the given authentication ID (aka the \"app connection\" on Zapier). Find them at https://zapier.com/app/assets/connections (https://zpr.io/z8SjFTdnTFZ2 for instructions) or specify '-' to interactively select one from your available authentications. When specified, the code will still run locally, but all outgoing requests will be proxied through Zapier with the production auth data.", "`--paging-token` | Set bundle.meta.paging_token. Used for search pagination or bulk reads. When used in production, this indicates which page of items you should fetch.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform invoke`", "`zapier-platform invoke auth start`", "`zapier-platform invoke auth refresh`", "`zapier-platform invoke auth test`", "`zapier-platform invoke auth label`", "`zapier-platform invoke trigger new_recipe`", "`zapier-platform invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'`", "`zapier-platform invoke search find_recipe -i @file.json --non-interactive`", "`cat file.json | zapier-platform invoke trigger new_recipe -i @-`", "`zapier-platform invoke search find_ticket --authentication-id 12345`", "`zapier-platform invoke create add_ticket -a -`", "`zapier-platform invoke trigger new_recipe --remote`", "`zapier-platform invoke trigger new_recipe -r -a 12345`", "`zapier-platform invoke -r -v 2.0.0 -a -`", "`zapier-platform invoke auth render '{\"access_token\":\"a_token\"}'`"], "args": ["`actionType` | The action type you want to invoke.", "`actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".", "`authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence over the .env file."], "examples": ["VAR_NAME=VALUE", "authData_FIELD_KEY=VALUE", "actionType", "actionKey", "authData", "-i, --inputData", "--isFillingDynamicDropdown", "--isLoadingSample", "--isPopulatingDedupe", "--limit", "-p, --page", "--non-interactive", "-z, --timezone", "--redirect-uri", "--local-port", "-r, --remote", "-v, --version", "-a, --authentication-id", "--paging-token", "-d, --debug", "zapier-platform invoke", "zapier-platform invoke auth start", "zapier-platform invoke auth refresh", "zapier-platform invoke auth test", "zapier-platform invoke auth label", "zapier-platform invoke trigger new_recipe", "zapier-platform invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'", "zapier-platform invoke search find_recipe -i @file.json --non-interactive", "cat file.json | zapier-platform invoke trigger new_recipe -i @-", "zapier-platform invoke search find_ticket --authentication-id 12345", "zapier-platform invoke create add_ticket -a -", "zapier-platform invoke trigger new_recipe --remote", "zapier-platform invoke trigger new_recipe -r -a 12345", "zapier-platform invoke -r -v 2.0.0 -a -", "zapier-platform invoke auth render '{\"access_token\":\"a_token\"}'"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "invoke"], "related": ["invoke", "test", "createAppTester"], "meta": {"surface": "platform_cli", "internals": "Local (default, .env), relay (-a auth id, traffic via Zapier), or remote (-r, production). Emulates (z, bundle)."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:invoke", "kind": "cli_command", "key": "invoke", "title": "zapier-platform invoke", "summary": "Invoke an authentication method, a trigger, or a create/search action locally or remotely.", "body": "# `invoke`\n\n> Invoke an authentication method, a trigger, or a create/search action locally or remotely.\n\n## High-level description\n\nInvoke an authentication method, a trigger, or a create/search action locally or remotely.\n\n## Internals\n\nLocal (default, .env), relay (-a auth id, traffic via Zapier), or remote (-r, production). Emulates (z, bundle).\n\n## Typed inputs\n\n```ts\ntype Input = {\n actionType?: string; // The action type you want to invoke.\n actionKey?: string; // The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".\n authData?: string; // Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence ov\n VAR_NAME=VALUE?: string | boolean; // `VAR_NAME=VALUE` for environment variables\n authData_FIELD_KEY=VALUE?: string | boolean; // `authData_FIELD_KEY=VALUE` for auth data fields\n actionType?: string | boolean; // `actionType` | The action type you want to invoke.\n actionKey?: string | boolean; // `actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".\n authData?: string | boolean; // `authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take \n i, __inputData?: string | boolean; // `-i, --inputData` | The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly li\n isFillingDynamicDropdown?: string | boolean; // `--isFillingDynamicDropdown` | Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in produc\n isLoadingSample?: string | boolean; // `--isLoadingSample` | Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor \n isPopulatingDedupe?: string | boolean; // `--isPopulatingDedupe` | Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the re\n limit?: string | boolean; // `--limit` | Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fe\n p, __page?: string | boolean; // `-p, --page` | Set bundle.meta.page. Only makes sense for a trigger. When used in production, this indicates which page of items you should \n non_interactive?: string | boolean; // `--non-interactive` | Do not show interactive prompts.\n z, __timezone?: string | boolean; // `-z, --timezone` | Set the default timezone for datetime field interpretation. If not set, defaults to America/Chicago, which matches Zapier\n redirect_uri?: string | boolean; // `--redirect-uri` | Only used by `auth start` subcommand. The redirect URI that will be passed to the OAuth2 authorization URL. Usually this \n local_port?: string | boolean; // `--local-port` | Only used by `auth start` subcommand. The local port that will be used to start the local HTTP server to listen for the OAu\n r, __remote?: string | boolean; // `-r, --remote` | Run your trigger/action remotely on Zapier production servers instead of locally. This requires deploying your integration \n v, __version?: string | boolean; // `-v, --version` | Only used when `--remote` is set. Specify a deployed version to invoke instead of the one currently set in your local pack\n a, __authentication_id?: string | boolean; // `-a, --authentication-id` | EXPERIMENTAL: Instead of using the local .env file, use the production authentication data with the given authen\n paging_token?: string | boolean; // `--paging-token` | Set bundle.meta.paging_token. Used for search pagination or bulk reads. When used in production, this indicates which pag\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform invoke?: string | boolean; // `zapier-platform invoke`\n zapier_platform invoke auth start?: string | boolean; // `zapier-platform invoke auth start`\n zapier_platform invoke auth refresh?: string | boolean; // `zapier-platform invoke auth refresh`\n zapier_platform invoke auth test?: string | boolean; // `zapier-platform invoke auth test`\n zapier_platform invoke auth label?: string | boolean; // `zapier-platform invoke auth label`\n zapier_platform invoke trigger new_recipe?: string | boolean; // `zapier-platform invoke trigger new_recipe`\n zapier_platform invoke create add_recipe __inputData '{\"title\": \"Pancakes\"}'?: string | boolean; // `zapier-platform invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'`\n zapier_platform invoke search find_recipe _i @file.json __non_interactive?: string | boolean; // `zapier-platform invoke search find_recipe -i @file.json --non-interactive`\n cat file.json | zapier_platform invoke trigger new_recipe _i @_?: string | boolean; // `cat file.json | zapier-platform invoke trigger new_recipe -i @-`\n zapier_platform invoke search find_ticket __authentication_id 12345?: string | boolean; // `zapier-platform invoke search find_ticket --authentication-id 12345`\n zapier_platform invoke create add_ticket _a _?: string | boolean; // `zapier-platform invoke create add_ticket -a -`\n zapier_platform invoke trigger new_recipe __remote?: string | boolean; // `zapier-platform invoke trigger new_recipe --remote`\n zapier_platform invoke trigger new_recipe _r _a 12345?: string | boolean; // `zapier-platform invoke trigger new_recipe -r -a 12345`\n zapier_platform invoke _r _v 2.0.0 _a _?: string | boolean; // `zapier-platform invoke -r -v 2.0.0 -a -`\n zapier_platform invoke auth render '{\"access_token\":\"a_token\"}'?: string | boolean; // `zapier-platform invoke auth render '{\"access_token\":\"a_token\"}'`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]`\n- Aliases: `zapier invoke`\n\n## Related functions\n\n- `invoke`\n- `test`\n- `createAppTester`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier invoke`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Invoke an authentication method, a trigger, or a create/search action locally or remotely.\n\n**Usage**: `zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]`\n\nThis command allows you to invoke your integration's authentication, triggers, and actions. With this tool, you can test and debug your integration code directly from your terminal without leaving your development environment and opening a browser.\n\nWhy use this command?\n\n* Fast feedback loops: Verify your code changes instantly.\n* Step-by-step debugging: Use a debugger to step through your code locally.\n* Untruncated logs: View complete HTTP logs and errors in your terminal.\n\n### Modes\n\nThe `invoke` command works in three modes:\n\n1. Local mode (default): runs your code locally, and sends outgoing requests directly from your local machine.\n2. Relay mode (experimental): runs your code locally, but proxies all outgoing requests through Zapier using production authentication data.\n3. Remote mode: runs your code and sends outgoing requests entirely in/from Zapier production environment.\n\n**Local mode** is the default mode. Without the `--remote` (or `-r`) flag or the `--authentication-id` (or `-a`) flag, the command runs in local mode. It's useful when you want to quickly test your integration code locally. You'll need to set up local auth data in the `.env` file using the `zapier-platform invoke auth start` command.\n\n**Relay mode** is currently experimental. It's enabled when the `-a` flag is specified. It's useful when you want to test code locally but setting up local auth data is troublesome, such as when your OAuth2 server requires a non-localhost or HTTPS redirect URI. By specifying `-a <authentication-id>`, all outgoing requests will be proxied through Zapier's relay service using the production auth data with the given authentication ID. See the **Authentication** section below for more details.\n\nBoth local and relay mode **emulate** how your code would run in Zapier production environment, so the behavior might not be exactly the same. But we consider every inconsistency a bug or a limitation to be fixed. For 100% match with production behavior, use remote mode.\n\n**Remote mode** is enabled when the `--remote` (or `-r`) flag is specified. It's useful when you want to verify how your code behaves in Zapier production environment. Note that remote mode requires deploying your integration first. If the `-a` flag is not specified, the command will prompt you to select one of your available authentications/connections in production. By default, the remote mode invokes the `version` set in your `package.json`. You can use the `--version` (or `-v`) flag to specify a different deployed version.\n\n### Authentication\n\nYou can supply the authentcation data in two ways: Load from the local `.env` file or use the `--authentication-id` flag.\n\n#### The local `.env` file\n\nThis command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier-platform invoke auth start` command to help you initialize it, or you can manually create it.\n\nThe `zapier-platform invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.\n\nEach line in the `.env` file should follow one of these formats:\n\n* `VAR_NAME=VALUE` for environment variables\n* `authData_FIELD_KEY=VALUE` for auth data fields\n\nFor example, a `.env` file for an OAuth2 integration might look like this:\n\n```\nCLIENT_ID='your_client_id'\nCLIENT_SECRET='your_client_secret'\nauthData_access_token='1234567890'\nauthData_refresh_token='abcdefg'\nauthData_account_name='zapier'\n```\n\n\n#### The `--authentication-id` flag\n\nSetting up local auth data can be troublesome. For instance, in OAuth2, you may have to configure your app server to allow localhost redirect URIs or use a port forwarding tool. This is sometimes not easy to get right.\n\nThe `--authentication-id` flag (`-a` for short) gives you an alternative (and perhaps easier) way to supply your auth data. You can use `-a` to specify an existing production authentication/connection. The available authentications can be found at https://zapier.com/app/assets/connections. Check https://zpr.io/z8SjFTdnTFZ2 for more instructions.\n\nWhen `-a -` is specified, such as `zapier-platform invoke auth test -a -`, the command will interactively prompt you to select one of your available authentications.\n\nIf you know your authentication ID, you can specify it directly, such as `zapier-platform invoke auth test -a 123456`.\n\nThe `-a` flag also works in remote mode with the `-r` flag. In remote mode, if `-a` is not specified, such as `zapier-platform invoke -r`, the command will prompt you to select one of your available authentications.\n\n#### Testing authentication\n\nTo test if the auth data is correct, run either one of these:\n\n```\nzapier-platform invoke auth test # invokes authentication.test method\nzapier-platform invoke auth label # invokes authentication.test and renders connection label\n```\n\nTo refresh stale auth data for OAuth2 or session auth, run `zapier-platform invoke auth refresh`. Note that refreshing is only applicable for local auth data in the `.env` file.\n\n### Invoking a trigger or an action\n\nOnce you have the correct auth data, you can test an trigger, a search, or a create action. For example, here's how you invoke a trigger with the key `new_recipe`:\n\n```\nzapier-platform invoke trigger new_recipe # (local mode)\nzapier-platform invoke trigger new_recipe -r # (remote mode)\n```\n\nTo add input data, use the `--inputData` flag (`-i` for short). The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.\n\nWhen you miss any command arguments, such as ACTIONTYPE or ACTIONKEY, the command will prompt you interactively. If you don't want to get interactive prompts, use the `--non-interactive` flag.\n\nThe `--debug` flag will show you the HTTP request logs and any console logs you have in your code.\n\n### Limitations in local and relay mode\n\nThe following is a non-exhaustive list of current limitations in local and relay mode. We may support them in the future.\n\n- Hook triggers, including REST hook subscribe/unsubscribe\n- Output hydration\n- File upload\n- Function-based connection label\n- Buffered create actions\n- Search-or-create actions\n- Search-powered fields\n- autoRefresh for OAuth2 and session auth\n\n\n**Arguments**\n* `actionType` | The action type you want to invoke.\n* `actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".\n* `authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence over the .env file.\n\n**Flags**\n* `-i, --inputData` | The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.\n* `--isFillingDynamicDropdown` | Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in production, this poll is being used to populate a dynamic dropdown.\n* `--isLoadingSample` | Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor trying to pull a sample.\n* `--isPopulatingDedupe` | Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the results of this poll will be used initialize the deduplication list rather than trigger a Zap. This happens when a user enables a Zap.\n* `--limit` | Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fetch. -1 means no limit\n\n## Examples\n\n```bash\nVAR_NAME=VALUE\n```\n```bash\nauthData_FIELD_KEY=VALUE\n```\n```bash\nactionType\n```\n```bash\nactionKey\n```\n```bash\nauthData\n```\n```bash\n-i, --inputData\n```\n```bash\n--isFillingDynamicDropdown\n```\n```bash\n--isLoadingSample\n```", "usage": "zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]", "signature": "zapier-platform invoke [ACTIONTYPE] [ACTIONKEY] [AUTHDATA]", "aliases": ["zapier invoke"], "flags": ["`VAR_NAME=VALUE` for environment variables", "`authData_FIELD_KEY=VALUE` for auth data fields", "`actionType` | The action type you want to invoke.", "`actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".", "`authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence over the .env file.", "`-i, --inputData` | The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.", "`--isFillingDynamicDropdown` | Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in production, this poll is being used to populate a dynamic dropdown.", "`--isLoadingSample` | Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor trying to pull a sample.", "`--isPopulatingDedupe` | Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the results of this poll will be used initialize the deduplication list rather than trigger a Zap. This happens when a user enables a Zap.", "`--limit` | Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fetch. -1 means no limit. Defaults to `-1`.", "`-p, --page` | Set bundle.meta.page. Only makes sense for a trigger. When used in production, this indicates which page of items you should fetch. First page is 0.", "`--non-interactive` | Do not show interactive prompts.", "`-z, --timezone` | Set the default timezone for datetime field interpretation. If not set, defaults to America/Chicago, which matches Zapier production behavior. Find the list timezone names at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Defaults to `America/Chicago`.", "`--redirect-uri` | Only used by `auth start` subcommand. The redirect URI that will be passed to the OAuth2 authorization URL. Usually this should match the one configured in your server's OAuth2 application settings. A local HTTP server will be started to listen for the OAuth2 callback. If your server requires a non-localhost or HTTPS address for the redirect URI, you can set up port forwarding to route the non-localhost or HTTPS address to localhost. Defaults to `http://localhost:9000`.", "`--local-port` | Only used by `auth start` subcommand. The local port that will be used to start the local HTTP server to listen for the OAuth2 callback. This port can be different from the one in the redirect URI if you have port forwarding set up. Defaults to `9000`.", "`-r, --remote` | Run your trigger/action remotely on Zapier production servers instead of locally. This requires deploying your integration first. Because this (remote) mode uses the same set of API endpoints as the Zap editor and other Zapier products, it allows you to verify exactly how your code will behave in production. Note that `--authentication-id` is required and implied in remote mode, as a production authentication is necessary to invoke in production.", "`-v, --version` | Only used when `--remote` is set. Specify a deployed version to invoke instead of the one currently set in your local package.json.", "`-a, --authentication-id` | EXPERIMENTAL: Instead of using the local .env file, use the production authentication data with the given authentication ID (aka the \"app connection\" on Zapier). Find them at https://zapier.com/app/assets/connections (https://zpr.io/z8SjFTdnTFZ2 for instructions) or specify '-' to interactively select one from your available authentications. When specified, the code will still run locally, but all outgoing requests will be proxied through Zapier with the production auth data.", "`--paging-token` | Set bundle.meta.paging_token. Used for search pagination or bulk reads. When used in production, this indicates which page of items you should fetch.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform invoke`", "`zapier-platform invoke auth start`", "`zapier-platform invoke auth refresh`", "`zapier-platform invoke auth test`", "`zapier-platform invoke auth label`", "`zapier-platform invoke trigger new_recipe`", "`zapier-platform invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'`", "`zapier-platform invoke search find_recipe -i @file.json --non-interactive`", "`cat file.json | zapier-platform invoke trigger new_recipe -i @-`", "`zapier-platform invoke search find_ticket --authentication-id 12345`", "`zapier-platform invoke create add_ticket -a -`", "`zapier-platform invoke trigger new_recipe --remote`", "`zapier-platform invoke trigger new_recipe -r -a 12345`", "`zapier-platform invoke -r -v 2.0.0 -a -`", "`zapier-platform invoke auth render '{\"access_token\":\"a_token\"}'`"], "args": ["`actionType` | The action type you want to invoke.", "`actionKey` | The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".", "`authData` | Only used by `auth render`. JSON-encoded object with auth field values (e.g. `'{\"access_token\":\"a_token\"}'`). Values here take precedence over the .env file."], "examples": ["VAR_NAME=VALUE", "authData_FIELD_KEY=VALUE", "actionType", "actionKey", "authData", "-i, --inputData", "--isFillingDynamicDropdown", "--isLoadingSample", "--isPopulatingDedupe", "--limit", "-p, --page", "--non-interactive", "-z, --timezone", "--redirect-uri", "--local-port", "-r, --remote", "-v, --version", "-a, --authentication-id", "--paging-token", "-d, --debug", "zapier-platform invoke", "zapier-platform invoke auth start", "zapier-platform invoke auth refresh", "zapier-platform invoke auth test", "zapier-platform invoke auth label", "zapier-platform invoke trigger new_recipe", "zapier-platform invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'", "zapier-platform invoke search find_recipe -i @file.json --non-interactive", "cat file.json | zapier-platform invoke trigger new_recipe -i @-", "zapier-platform invoke search find_ticket --authentication-id 12345", "zapier-platform invoke create add_ticket -a -", "zapier-platform invoke trigger new_recipe --remote", "zapier-platform invoke trigger new_recipe -r -a 12345", "zapier-platform invoke -r -v 2.0.0 -a -", "zapier-platform invoke auth render '{\"access_token\":\"a_token\"}'"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "invoke"], "related": ["invoke", "test", "createAppTester"], "meta": {"surface": "platform_cli", "internals": "Local (default, .env), relay (-a auth id, traffic via Zapier), or remote (-r, production). Emulates (z, bundle)."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:jobs", "kind": "cli_function", "key": "jobs", "title": "zapier-platform jobs", "summary": "Lists ongoing migration or promotion jobs for the current integration.", "body": "# `jobs`\n\n> Lists ongoing migration or promotion jobs for the current integration.\n\n## High-level description\n\nLists ongoing migration or promotion jobs for the current integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform jobs?: string | boolean; // `zapier-platform jobs`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform jobs`\n- Aliases: `zapier jobs`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier jobs`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Lists ongoing migration or promotion jobs for the current integration.\n\n**Usage**: `zapier-platform jobs`\n\nA job represents a background process that will be queued up when users execute a \"migrate\" or \"promote\" command for the current integration.\n\nEach job will be added to the end of a queue of \"promote\" and \"migration\" jobs where the \"Job Stage\" will then be initialized with \"requested\".\n\nJob stages will then move to \"estimating\", \"in_progress\" and finally one of four \"end\" stages: \"complete\", \"aborted\", \"errored\" or \"paused\".\n\nJob times will vary as it depends on the size of the queue and how many users your integration has.\n\nJobs are returned from oldest to newest.\n\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform jobs`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform jobs\n```", "usage": "zapier-platform jobs", "signature": "zapier-platform jobs", "aliases": ["zapier jobs"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform jobs`"], "args": [], "examples": ["-d, --debug", "-f, --format", "zapier-platform jobs"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "jobs"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:jobs", "kind": "cli_command", "key": "jobs", "title": "zapier-platform jobs", "summary": "Lists ongoing migration or promotion jobs for the current integration.", "body": "# `jobs`\n\n> Lists ongoing migration or promotion jobs for the current integration.\n\n## High-level description\n\nLists ongoing migration or promotion jobs for the current integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform jobs?: string | boolean; // `zapier-platform jobs`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform jobs`\n- Aliases: `zapier jobs`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier jobs`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Lists ongoing migration or promotion jobs for the current integration.\n\n**Usage**: `zapier-platform jobs`\n\nA job represents a background process that will be queued up when users execute a \"migrate\" or \"promote\" command for the current integration.\n\nEach job will be added to the end of a queue of \"promote\" and \"migration\" jobs where the \"Job Stage\" will then be initialized with \"requested\".\n\nJob stages will then move to \"estimating\", \"in_progress\" and finally one of four \"end\" stages: \"complete\", \"aborted\", \"errored\" or \"paused\".\n\nJob times will vary as it depends on the size of the queue and how many users your integration has.\n\nJobs are returned from oldest to newest.\n\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform jobs`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform jobs\n```", "usage": "zapier-platform jobs", "signature": "zapier-platform jobs", "aliases": ["zapier jobs"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform jobs`"], "args": [], "examples": ["-d, --debug", "-f, --format", "zapier-platform jobs"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "jobs"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:legacy", "kind": "cli_function", "key": "legacy", "title": "zapier-platform legacy", "summary": "Mark a non-production version of your integration as legacy.", "body": "# `legacy`\n\n> Mark a non-production version of your integration as legacy.\n\n## High-level description\n\nMark a non-production version of your integration as legacy.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to mark as legacy.\n version?: string | boolean; // (required) `version` | The version to mark as legacy.\n f, __force?: string | boolean; // `-f, --force` | Skip confirmation prompt. Use with caution.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform legacy 1.2.3?: string | boolean; // `zapier-platform legacy 1.2.3`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform legacy VERSION`\n- Aliases: `zapier legacy`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier legacy`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Mark a non-production version of your integration as legacy.\n\n**Usage**: `zapier-platform legacy VERSION`\n\nUse this when an integration version is no longer recommended for new users, but you don't want to block existing users from using it.\n\nReasons why you might want to mark a version as legacy:\n- this version may be discontinued in the future\n- this version has bugs\n- a newer version has been released and you want to encourage users to upgrade\n\n**Arguments**\n* (required) `version` | The version to mark as legacy.\n\n**Flags**\n* `-f, --force` | Skip confirmation prompt. Use with caution.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform legacy 1.2.3`\n\n## Examples\n\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform legacy 1.2.3\n```", "usage": "zapier-platform legacy VERSION", "signature": "zapier-platform legacy VERSION", "aliases": ["zapier legacy"], "flags": ["(required) `version` | The version to mark as legacy.", "`-f, --force` | Skip confirmation prompt. Use with caution.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform legacy 1.2.3`"], "args": ["(required) `version` | The version to mark as legacy."], "examples": ["-f, --force", "-d, --debug", "zapier-platform legacy 1.2.3"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "legacy"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:legacy", "kind": "cli_command", "key": "legacy", "title": "zapier-platform legacy", "summary": "Mark a non-production version of your integration as legacy.", "body": "# `legacy`\n\n> Mark a non-production version of your integration as legacy.\n\n## High-level description\n\nMark a non-production version of your integration as legacy.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version to mark as legacy.\n version?: string | boolean; // (required) `version` | The version to mark as legacy.\n f, __force?: string | boolean; // `-f, --force` | Skip confirmation prompt. Use with caution.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform legacy 1.2.3?: string | boolean; // `zapier-platform legacy 1.2.3`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform legacy VERSION`\n- Aliases: `zapier legacy`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier legacy`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Mark a non-production version of your integration as legacy.\n\n**Usage**: `zapier-platform legacy VERSION`\n\nUse this when an integration version is no longer recommended for new users, but you don't want to block existing users from using it.\n\nReasons why you might want to mark a version as legacy:\n- this version may be discontinued in the future\n- this version has bugs\n- a newer version has been released and you want to encourage users to upgrade\n\n**Arguments**\n* (required) `version` | The version to mark as legacy.\n\n**Flags**\n* `-f, --force` | Skip confirmation prompt. Use with caution.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform legacy 1.2.3`\n\n## Examples\n\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform legacy 1.2.3\n```", "usage": "zapier-platform legacy VERSION", "signature": "zapier-platform legacy VERSION", "aliases": ["zapier legacy"], "flags": ["(required) `version` | The version to mark as legacy.", "`-f, --force` | Skip confirmation prompt. Use with caution.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform legacy 1.2.3`"], "args": ["(required) `version` | The version to mark as legacy."], "examples": ["-f, --force", "-d, --debug", "zapier-platform legacy 1.2.3"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "legacy"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:link", "kind": "cli_function", "key": "link", "title": "zapier-platform link", "summary": "Link the current directory with an existing integration.", "body": "# `link`\n\n> Link the current directory with an existing integration.\n\n## High-level description\n\nLink the current directory with an existing integration.\n\n## Internals\n\nWrites .zapierapprc pointing at an existing integration id.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform link`\n- Aliases: `zapier link`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier link`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Link the current directory with an existing integration.\n\n**Usage**: `zapier-platform link`\n\nThis command generates a `.zapierapprc` file in the directory in which it's ran. This file ties this code to an integration and is referenced frequently during `push` and `validate` operations. This file should be checked into source control.\n\nIf you're starting an integration from scratch, use `zapier-platform init` instead.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform link", "signature": "zapier-platform link", "aliases": ["zapier link"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "link"], "related": [], "meta": {"surface": "platform_cli", "internals": "Writes .zapierapprc pointing at an existing integration id."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:link", "kind": "cli_command", "key": "link", "title": "zapier-platform link", "summary": "Link the current directory with an existing integration.", "body": "# `link`\n\n> Link the current directory with an existing integration.\n\n## High-level description\n\nLink the current directory with an existing integration.\n\n## Internals\n\nWrites .zapierapprc pointing at an existing integration id.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform link`\n- Aliases: `zapier link`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier link`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Link the current directory with an existing integration.\n\n**Usage**: `zapier-platform link`\n\nThis command generates a `.zapierapprc` file in the directory in which it's ran. This file ties this code to an integration and is referenced frequently during `push` and `validate` operations. This file should be checked into source control.\n\nIf you're starting an integration from scratch, use `zapier-platform init` instead.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform link", "signature": "zapier-platform link", "aliases": ["zapier link"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "link"], "related": [], "meta": {"surface": "platform_cli", "internals": "Writes .zapierapprc pointing at an existing integration id."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:login", "kind": "cli_function", "key": "login", "title": "zapier-platform login", "summary": "Configure your `~/.zapierrc` with a deploy key.", "body": "# `login`\n\n> Configure your `~/.zapierrc` with a deploy key.\n\n## High-level description\n\nConfigure your `~/.zapierrc` with a deploy key.\n\n## Internals\n\nStores a deploy key in ~/.zapierrc (SSO via --sso).\n\n## Typed inputs\n\n```ts\ntype Input = {\n s, __sso?: string | boolean; // `-s, --sso` | Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform login`\n- Aliases: `zapier login`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier login`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Configure your `~/.zapierrc` with a deploy key.\n\n**Usage**: `zapier-platform login`\n\n**Flags**\n* `-s, --sso` | Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-s, --sso\n```\n```bash\n-d, --debug\n```", "usage": "zapier-platform login", "signature": "zapier-platform login", "aliases": ["zapier login"], "flags": ["`-s, --sso` | Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.", "`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-s, --sso", "-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "login"], "related": [], "meta": {"surface": "platform_cli", "internals": "Stores a deploy key in ~/.zapierrc (SSO via --sso)."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:login", "kind": "cli_command", "key": "login", "title": "zapier-platform login", "summary": "Configure your `~/.zapierrc` with a deploy key.", "body": "# `login`\n\n> Configure your `~/.zapierrc` with a deploy key.\n\n## High-level description\n\nConfigure your `~/.zapierrc` with a deploy key.\n\n## Internals\n\nStores a deploy key in ~/.zapierrc (SSO via --sso).\n\n## Typed inputs\n\n```ts\ntype Input = {\n s, __sso?: string | boolean; // `-s, --sso` | Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform login`\n- Aliases: `zapier login`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier login`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Configure your `~/.zapierrc` with a deploy key.\n\n**Usage**: `zapier-platform login`\n\n**Flags**\n* `-s, --sso` | Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-s, --sso\n```\n```bash\n-d, --debug\n```", "usage": "zapier-platform login", "signature": "zapier-platform login", "aliases": ["zapier login"], "flags": ["`-s, --sso` | Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.", "`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-s, --sso", "-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "login"], "related": [], "meta": {"surface": "platform_cli", "internals": "Stores a deploy key in ~/.zapierrc (SSO via --sso)."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:logout", "kind": "cli_function", "key": "logout", "title": "zapier-platform logout", "summary": "Deactivate your active deploy key and reset `~/.zapierrc`.", "body": "# `logout`\n\n> Deactivate your active deploy key and reset `~/.zapierrc`.\n\n## High-level description\n\nDeactivate your active deploy key and reset `~/.zapierrc`.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform logout`\n- Aliases: `zapier logout`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier logout`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Deactivate your active deploy key and reset `~/.zapierrc`.\n\n**Usage**: `zapier-platform logout`\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform logout", "signature": "zapier-platform logout", "aliases": ["zapier logout"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "logout"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:logout", "kind": "cli_command", "key": "logout", "title": "zapier-platform logout", "summary": "Deactivate your active deploy key and reset `~/.zapierrc`.", "body": "# `logout`\n\n> Deactivate your active deploy key and reset `~/.zapierrc`.\n\n## High-level description\n\nDeactivate your active deploy key and reset `~/.zapierrc`.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform logout`\n- Aliases: `zapier logout`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier logout`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Deactivate your active deploy key and reset `~/.zapierrc`.\n\n**Usage**: `zapier-platform logout`\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform logout", "signature": "zapier-platform logout", "aliases": ["zapier logout"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "logout"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:logs", "kind": "cli_function", "key": "logs", "title": "zapier-platform logs", "summary": "Print recent logs.", "body": "# `logs`\n\n> Print recent logs.\n\n## High-level description\n\nPrint recent logs.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n v, __version?: string | boolean; // `-v, --version` | Filter logs to the specified version.\n s, __status?: string | boolean; // `-s, --status` | Filter logs to only see errors or successes One of `[any | success | error]`. Defaults to `any`.\n t, __type?: string | boolean; // `-t, --type` | See logs of the specified type One of `[console | bundle | http]`. Defaults to `console`.\n detailed?: string | boolean; // `--detailed` | See extra info, like request/response body and headers.\n u, __user?: string | boolean; // `-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`.\n limit?: string | boolean; // `--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform logs`\n- Aliases: `zapier logs`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier logs`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Print recent logs.\n\n**Usage**: `zapier-platform logs`\n\nLogs are created when your integration is run as part of a Zap. They come from explicit calls to `z.console.log()`, usage of `z.request()`, and any runtime errors.\n\nThis won't show logs from running locally with `zapier-platform test`, since those never hit our server.\n\n**Flags**\n* `-v, --version` | Filter logs to the specified version.\n* `-s, --status` | Filter logs to only see errors or successes One of `[any | success | error]`. Defaults to `any`.\n* `-t, --type` | See logs of the specified type One of `[console | bundle | http]`. Defaults to `console`.\n* `--detailed` | See extra info, like request/response body and headers.\n* `-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`.\n* `--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`.\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-v, --version\n```\n```bash\n-s, --status\n```\n```bash\n-t, --type\n```\n```bash\n--detailed\n```\n```bash\n-u, --user\n```\n```bash\n--limit\n```\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform logs", "signature": "zapier-platform logs", "aliases": ["zapier logs"], "flags": ["`-v, --version` | Filter logs to the specified version.", "`-s, --status` | Filter logs to only see errors or successes One of `[any | success | error]`. Defaults to `any`.", "`-t, --type` | See logs of the specified type One of `[console | bundle | http]`. Defaults to `console`.", "`--detailed` | See extra info, like request/response body and headers.", "`-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`.", "`--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-v, --version", "-s, --status", "-t, --type", "--detailed", "-u, --user", "--limit", "-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "logs"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:logs", "kind": "cli_command", "key": "logs", "title": "zapier-platform logs", "summary": "Print recent logs.", "body": "# `logs`\n\n> Print recent logs.\n\n## High-level description\n\nPrint recent logs.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n v, __version?: string | boolean; // `-v, --version` | Filter logs to the specified version.\n s, __status?: string | boolean; // `-s, --status` | Filter logs to only see errors or successes One of `[any | success | error]`. Defaults to `any`.\n t, __type?: string | boolean; // `-t, --type` | See logs of the specified type One of `[console | bundle | http]`. Defaults to `console`.\n detailed?: string | boolean; // `--detailed` | See extra info, like request/response body and headers.\n u, __user?: string | boolean; // `-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`.\n limit?: string | boolean; // `--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform logs`\n- Aliases: `zapier logs`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier logs`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Print recent logs.\n\n**Usage**: `zapier-platform logs`\n\nLogs are created when your integration is run as part of a Zap. They come from explicit calls to `z.console.log()`, usage of `z.request()`, and any runtime errors.\n\nThis won't show logs from running locally with `zapier-platform test`, since those never hit our server.\n\n**Flags**\n* `-v, --version` | Filter logs to the specified version.\n* `-s, --status` | Filter logs to only see errors or successes One of `[any | success | error]`. Defaults to `any`.\n* `-t, --type` | See logs of the specified type One of `[console | bundle | http]`. Defaults to `console`.\n* `--detailed` | See extra info, like request/response body and headers.\n* `-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`.\n* `--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`.\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-v, --version\n```\n```bash\n-s, --status\n```\n```bash\n-t, --type\n```\n```bash\n--detailed\n```\n```bash\n-u, --user\n```\n```bash\n--limit\n```\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform logs", "signature": "zapier-platform logs", "aliases": ["zapier logs"], "flags": ["`-v, --version` | Filter logs to the specified version.", "`-s, --status` | Filter logs to only see errors or successes One of `[any | success | error]`. Defaults to `any`.", "`-t, --type` | See logs of the specified type One of `[console | bundle | http]`. Defaults to `console`.", "`--detailed` | See extra info, like request/response body and headers.", "`-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`.", "`--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-v, --version", "-s, --status", "-t, --type", "--detailed", "-u, --user", "--limit", "-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "logs"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:migrate", "kind": "cli_function", "key": "migrate", "title": "zapier-platform migrate", "summary": "Migrate a percentage of users or a single user from one version of your integration to another.", "body": "# `migrate`\n\n> Migrate a percentage of users or a single user from one version of your integration to another.\n\n## High-level description\n\nMigrate a percentage of users or a single user from one version of your integration to another.\n\n## Internals\n\nMoves users FROM→TO (optional percent). Non-breaking only. Track with jobs.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version FROM which to migrate users.\n required: string; // The version TO which to migrate users.\n percent?: string; // Percentage (between 1 and 100) of users to migrate.\n fromVersion?: string | boolean; // (required) `fromVersion` | The version FROM which to migrate users.\n toVersion?: string | boolean; // (required) `toVersion` | The version TO which to migrate users.\n percent?: string | boolean; // `percent` | Percentage (between 1 and 100) of users to migrate.\n user?: string | boolean; // `--user` | Migrates a user's private Zaps under the user's individual account, excluding organization accounts\n account?: string | boolean; // `--account` | Migrates a user's private and shared Zaps under the user's individual and organization accounts\n y, __yes?: string | boolean; // `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform migrate 1.0.0 1.0.1?: string | boolean; // `zapier-platform migrate 1.0.0 1.0.1`\n zapier_platform migrate 1.0.1 2.0.0 10?: string | boolean; // `zapier-platform migrate 1.0.1 2.0.0 10`\n zapier_platform migrate 2.0.0 2.0.1 __user=user@example.com?: string | boolean; // `zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com`\n zapier_platform migrate 2.0.0 2.0.1 __account=account@example.com?: string | boolean; // `zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform migrate FROMVERSION TOVERSION [PERCENT]`\n- Aliases: `zapier migrate`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier migrate`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Migrate a percentage of users or a single user from one version of your integration to another.\n\n**Usage**: `zapier-platform migrate FROMVERSION TOVERSION [PERCENT]`\n\nStart a migration to move users between different versions of your integration. You may also \"revert\" by simply swapping the from/to verion strings in the command line arguments (i.e. `zapier-platform migrate 1.0.1 1.0.0`).\n\n**Only use this command to migrate users between non-breaking versions, use `zapier-platform deprecate` if you have breaking changes!**\n\nMigration time varies based on the number of affected Zaps. Be patient and check `zapier-platform jobs` to track the status. Or use `zapier-platform history` if you want to see older jobs.\n\nSince a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.\n\nWe recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.\n\nYou can migrate a specific user's Zaps by using `--user` (i.e. `zapier-platform migrate 1.0.0 1.0.1 --user=user@example.com`). This will migrate Zaps that are private for that user. Zaps that are\n\n - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),\n - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or\n - in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account)\n\nwill **not** be migrated.\n\nAlternatively, you can pass the `--account` flag, (i.e. `zapier-platform migrate 1.0.0 1.0.1 --account=account@example.com`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member.\n\n**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**\n\nYou cannot pass both `PERCENT` and `--user` or `--account`.\n\nYou cannot pass both `--user` and `--account`.\n\n**Arguments**\n* (required) `fromVersion` | The version FROM which to migrate users.\n* (required) `toVersion` | The version TO which to migrate users.\n* `percent` | Percentage (between 1 and 100) of users to migrate.\n\n**Flags**\n* `--user` | Migrates a user's private Zaps under the user's individual account, excluding organization accounts\n* `--account` | Migrates a user's private and shared Zaps under the user's individual and organization accounts\n* `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform migrate 1.0.0 1.0.1`\n* `zapier-platform migrate 1.0.1 2.0.0 10`\n* `zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com`\n* `zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com`\n\n## Examples\n\n```bash\npercent\n```\n```bash\n--user\n```\n```bash\n--account\n```\n```bash\n-y, --yes\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform migrate 1.0.0 1.0.1\n```\n```bash\nzapier-platform migrate 1.0.1 2.0.0 10\n```\n```bash\nzapier-platform migrate 2.0.0 2.0.1 --user=user@example.com\n```", "usage": "zapier-platform migrate FROMVERSION TOVERSION [PERCENT]", "signature": "zapier-platform migrate FROMVERSION TOVERSION [PERCENT]", "aliases": ["zapier migrate"], "flags": ["(required) `fromVersion` | The version FROM which to migrate users.", "(required) `toVersion` | The version TO which to migrate users.", "`percent` | Percentage (between 1 and 100) of users to migrate.", "`--user` | Migrates a user's private Zaps under the user's individual account, excluding organization accounts", "`--account` | Migrates a user's private and shared Zaps under the user's individual and organization accounts", "`-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform migrate 1.0.0 1.0.1`", "`zapier-platform migrate 1.0.1 2.0.0 10`", "`zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com`", "`zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com`"], "args": ["(required) `fromVersion` | The version FROM which to migrate users.", "(required) `toVersion` | The version TO which to migrate users.", "`percent` | Percentage (between 1 and 100) of users to migrate."], "examples": ["percent", "--user", "--account", "-y, --yes", "-d, --debug", "zapier-platform migrate 1.0.0 1.0.1", "zapier-platform migrate 1.0.1 2.0.0 10", "zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com", "zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "migrate"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Moves users FROM→TO (optional percent). Non-breaking only. Track with jobs."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:migrate", "kind": "cli_command", "key": "migrate", "title": "zapier-platform migrate", "summary": "Migrate a percentage of users or a single user from one version of your integration to another.", "body": "# `migrate`\n\n> Migrate a percentage of users or a single user from one version of your integration to another.\n\n## High-level description\n\nMigrate a percentage of users or a single user from one version of your integration to another.\n\n## Internals\n\nMoves users FROM→TO (optional percent). Non-breaking only. Track with jobs.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version FROM which to migrate users.\n required: string; // The version TO which to migrate users.\n percent?: string; // Percentage (between 1 and 100) of users to migrate.\n fromVersion?: string | boolean; // (required) `fromVersion` | The version FROM which to migrate users.\n toVersion?: string | boolean; // (required) `toVersion` | The version TO which to migrate users.\n percent?: string | boolean; // `percent` | Percentage (between 1 and 100) of users to migrate.\n user?: string | boolean; // `--user` | Migrates a user's private Zaps under the user's individual account, excluding organization accounts\n account?: string | boolean; // `--account` | Migrates a user's private and shared Zaps under the user's individual and organization accounts\n y, __yes?: string | boolean; // `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform migrate 1.0.0 1.0.1?: string | boolean; // `zapier-platform migrate 1.0.0 1.0.1`\n zapier_platform migrate 1.0.1 2.0.0 10?: string | boolean; // `zapier-platform migrate 1.0.1 2.0.0 10`\n zapier_platform migrate 2.0.0 2.0.1 __user=user@example.com?: string | boolean; // `zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com`\n zapier_platform migrate 2.0.0 2.0.1 __account=account@example.com?: string | boolean; // `zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform migrate FROMVERSION TOVERSION [PERCENT]`\n- Aliases: `zapier migrate`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier migrate`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Migrate a percentage of users or a single user from one version of your integration to another.\n\n**Usage**: `zapier-platform migrate FROMVERSION TOVERSION [PERCENT]`\n\nStart a migration to move users between different versions of your integration. You may also \"revert\" by simply swapping the from/to verion strings in the command line arguments (i.e. `zapier-platform migrate 1.0.1 1.0.0`).\n\n**Only use this command to migrate users between non-breaking versions, use `zapier-platform deprecate` if you have breaking changes!**\n\nMigration time varies based on the number of affected Zaps. Be patient and check `zapier-platform jobs` to track the status. Or use `zapier-platform history` if you want to see older jobs.\n\nSince a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.\n\nWe recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.\n\nYou can migrate a specific user's Zaps by using `--user` (i.e. `zapier-platform migrate 1.0.0 1.0.1 --user=user@example.com`). This will migrate Zaps that are private for that user. Zaps that are\n\n - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),\n - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or\n - in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account)\n\nwill **not** be migrated.\n\nAlternatively, you can pass the `--account` flag, (i.e. `zapier-platform migrate 1.0.0 1.0.1 --account=account@example.com`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member.\n\n**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**\n\nYou cannot pass both `PERCENT` and `--user` or `--account`.\n\nYou cannot pass both `--user` and `--account`.\n\n**Arguments**\n* (required) `fromVersion` | The version FROM which to migrate users.\n* (required) `toVersion` | The version TO which to migrate users.\n* `percent` | Percentage (between 1 and 100) of users to migrate.\n\n**Flags**\n* `--user` | Migrates a user's private Zaps under the user's individual account, excluding organization accounts\n* `--account` | Migrates a user's private and shared Zaps under the user's individual and organization accounts\n* `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform migrate 1.0.0 1.0.1`\n* `zapier-platform migrate 1.0.1 2.0.0 10`\n* `zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com`\n* `zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com`\n\n## Examples\n\n```bash\npercent\n```\n```bash\n--user\n```\n```bash\n--account\n```\n```bash\n-y, --yes\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform migrate 1.0.0 1.0.1\n```\n```bash\nzapier-platform migrate 1.0.1 2.0.0 10\n```\n```bash\nzapier-platform migrate 2.0.0 2.0.1 --user=user@example.com\n```", "usage": "zapier-platform migrate FROMVERSION TOVERSION [PERCENT]", "signature": "zapier-platform migrate FROMVERSION TOVERSION [PERCENT]", "aliases": ["zapier migrate"], "flags": ["(required) `fromVersion` | The version FROM which to migrate users.", "(required) `toVersion` | The version TO which to migrate users.", "`percent` | Percentage (between 1 and 100) of users to migrate.", "`--user` | Migrates a user's private Zaps under the user's individual account, excluding organization accounts", "`--account` | Migrates a user's private and shared Zaps under the user's individual and organization accounts", "`-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform migrate 1.0.0 1.0.1`", "`zapier-platform migrate 1.0.1 2.0.0 10`", "`zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com`", "`zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com`"], "args": ["(required) `fromVersion` | The version FROM which to migrate users.", "(required) `toVersion` | The version TO which to migrate users.", "`percent` | Percentage (between 1 and 100) of users to migrate."], "examples": ["percent", "--user", "--account", "-y, --yes", "-d, --debug", "zapier-platform migrate 1.0.0 1.0.1", "zapier-platform migrate 1.0.1 2.0.0 10", "zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com", "zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "migrate"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Moves users FROM→TO (optional percent). Non-breaking only. Track with jobs."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:promote", "kind": "cli_function", "key": "promote", "title": "zapier-platform promote", "summary": "Promote a specific version to public access.", "body": "# `promote`\n\n> Promote a specific version to public access.\n\n## High-level description\n\nPromote a specific version to public access.\n\n## Internals\n\nMarks a pushed version as the public default. Does not migrate users.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version you want to promote.\n zapier_platform push?: string | boolean; // This does **NOT** build/upload or deploy a version to Zapier - you should `zapier-platform push` first.\n zapier_platform migrate 1.0.0 1.0.1?: string | boolean; // This does **NOT** move old users over to this version - `zapier-platform migrate 1.0.0 1.0.1` does that.\n zapier_platform deprecate 1.0.0 2017_01_01?: string | boolean; // This does **NOT** recommend old users stop using this version - `zapier-platform deprecate 1.0.0 2017-01-01` does that.\n version?: string | boolean; // (required) `version` | The version you want to promote.\n y, __yes?: string | boolean; // `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform promote 1.0.0?: string | boolean; // `zapier-platform promote 1.0.0`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform promote VERSION`\n- Aliases: `zapier promote`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier promote`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Promote a specific version to public access.\n\n**Usage**: `zapier-platform promote VERSION`\n\nPromote an integration version into production (non-private) rotation, which means new users can use this integration version.\n\n* This **does** mark the version as the official public version - all other versions & users are grandfathered.\n* This does **NOT** build/upload or deploy a version to Zapier - you should `zapier-platform push` first.\n* This does **NOT** move old users over to this version - `zapier-platform migrate 1.0.0 1.0.1` does that.\n* This does **NOT** recommend old users stop using this version - `zapier-platform deprecate 1.0.0 2017-01-01` does that.\n\nPromotes are an inherently safe operation for all existing users of your integration.\n\nAfter a promotion, go to your developer platform to [close issues that were resolved](https://platform.zapier.com/manage/user-feedback#3-close-resolved-issues) in the updated version.\n\nIf your integration is private and passes our integration checks, this will give you a URL to a form where you can fill in additional information for your integration to go public. After reviewing, the Zapier team will approve to make it public if there are no issues or decline with feedback.\n\nCheck `zapier-platform jobs` to track the status of the promotion. Or use `zapier-platform history` if you want to see older jobs.\n\n**Arguments**\n* (required) `version` | The version you want to promote.\n\n**Flags**\n* `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform promote 1.0.0`\n\n## Examples\n\n```bash\n-y, --yes\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform promote 1.0.0\n```", "usage": "zapier-platform promote VERSION", "signature": "zapier-platform promote VERSION", "aliases": ["zapier promote"], "flags": ["This does **NOT** build/upload or deploy a version to Zapier - you should `zapier-platform push` first.", "This does **NOT** move old users over to this version - `zapier-platform migrate 1.0.0 1.0.1` does that.", "This does **NOT** recommend old users stop using this version - `zapier-platform deprecate 1.0.0 2017-01-01` does that.", "(required) `version` | The version you want to promote.", "`-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform promote 1.0.0`"], "args": ["(required) `version` | The version you want to promote."], "examples": ["-y, --yes", "-d, --debug", "zapier-platform promote 1.0.0"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "promote"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Marks a pushed version as the public default. Does not migrate users."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:promote", "kind": "cli_command", "key": "promote", "title": "zapier-platform promote", "summary": "Promote a specific version to public access.", "body": "# `promote`\n\n> Promote a specific version to public access.\n\n## High-level description\n\nPromote a specific version to public access.\n\n## Internals\n\nMarks a pushed version as the public default. Does not migrate users.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The version you want to promote.\n zapier_platform push?: string | boolean; // This does **NOT** build/upload or deploy a version to Zapier - you should `zapier-platform push` first.\n zapier_platform migrate 1.0.0 1.0.1?: string | boolean; // This does **NOT** move old users over to this version - `zapier-platform migrate 1.0.0 1.0.1` does that.\n zapier_platform deprecate 1.0.0 2017_01_01?: string | boolean; // This does **NOT** recommend old users stop using this version - `zapier-platform deprecate 1.0.0 2017-01-01` does that.\n version?: string | boolean; // (required) `version` | The version you want to promote.\n y, __yes?: string | boolean; // `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform promote 1.0.0?: string | boolean; // `zapier-platform promote 1.0.0`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform promote VERSION`\n- Aliases: `zapier promote`\n\n## Related functions\n\n- `promote`\n- `migrate`\n- `deprecate`\n- `jobs`\n- `versions`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier promote`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Promote a specific version to public access.\n\n**Usage**: `zapier-platform promote VERSION`\n\nPromote an integration version into production (non-private) rotation, which means new users can use this integration version.\n\n* This **does** mark the version as the official public version - all other versions & users are grandfathered.\n* This does **NOT** build/upload or deploy a version to Zapier - you should `zapier-platform push` first.\n* This does **NOT** move old users over to this version - `zapier-platform migrate 1.0.0 1.0.1` does that.\n* This does **NOT** recommend old users stop using this version - `zapier-platform deprecate 1.0.0 2017-01-01` does that.\n\nPromotes are an inherently safe operation for all existing users of your integration.\n\nAfter a promotion, go to your developer platform to [close issues that were resolved](https://platform.zapier.com/manage/user-feedback#3-close-resolved-issues) in the updated version.\n\nIf your integration is private and passes our integration checks, this will give you a URL to a form where you can fill in additional information for your integration to go public. After reviewing, the Zapier team will approve to make it public if there are no issues or decline with feedback.\n\nCheck `zapier-platform jobs` to track the status of the promotion. Or use `zapier-platform history` if you want to see older jobs.\n\n**Arguments**\n* (required) `version` | The version you want to promote.\n\n**Flags**\n* `-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform promote 1.0.0`\n\n## Examples\n\n```bash\n-y, --yes\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform promote 1.0.0\n```", "usage": "zapier-platform promote VERSION", "signature": "zapier-platform promote VERSION", "aliases": ["zapier promote"], "flags": ["This does **NOT** build/upload or deploy a version to Zapier - you should `zapier-platform push` first.", "This does **NOT** move old users over to this version - `zapier-platform migrate 1.0.0 1.0.1` does that.", "This does **NOT** recommend old users stop using this version - `zapier-platform deprecate 1.0.0 2017-01-01` does that.", "(required) `version` | The version you want to promote.", "`-y, --yes` | Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform promote 1.0.0`"], "args": ["(required) `version` | The version you want to promote."], "examples": ["-y, --yes", "-d, --debug", "zapier-platform promote 1.0.0"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "promote"], "related": ["promote", "migrate", "deprecate", "jobs", "versions"], "meta": {"surface": "platform_cli", "internals": "Marks a pushed version as the public default. Does not migrate users."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:pull", "kind": "cli_function", "key": "pull", "title": "zapier-platform pull", "summary": "Retrieve and update your local integration files with the promoted version (or latest version if not public).", "body": "# `pull`\n\n> Retrieve and update your local integration files with the promoted version (or latest version if not public).\n\n## High-level description\n\nRetrieve and update your local integration files with the promoted version (or latest version if not public).\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform pull`\n- Aliases: `zapier pull`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier pull`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Retrieve and update your local integration files with the promoted version (or latest version if not public).\n\n**Usage**: `zapier-platform pull`\n\nThis command updates your local integration files with the promoted version (or latest version if not public). You will be prompted with a confirmation dialog before continuing if there any destructive file changes.\n\nZapier may release new versions of your integration with bug fixes or new features. In the event this occurs, you will be unable to do the following until your local files are updated by running `zapier-platform pull`:\n\n* push to the promoted version\n* promote a new version\n* migrate users from one version to another\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform pull", "signature": "zapier-platform pull", "aliases": ["zapier pull"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "pull"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:pull", "kind": "cli_command", "key": "pull", "title": "zapier-platform pull", "summary": "Retrieve and update your local integration files with the promoted version (or latest version if not public).", "body": "# `pull`\n\n> Retrieve and update your local integration files with the promoted version (or latest version if not public).\n\n## High-level description\n\nRetrieve and update your local integration files with the promoted version (or latest version if not public).\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform pull`\n- Aliases: `zapier pull`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier pull`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Retrieve and update your local integration files with the promoted version (or latest version if not public).\n\n**Usage**: `zapier-platform pull`\n\nThis command updates your local integration files with the promoted version (or latest version if not public). You will be prompted with a confirmation dialog before continuing if there any destructive file changes.\n\nZapier may release new versions of your integration with bug fixes or new features. In the event this occurs, you will be unable to do the following until your local files are updated by running `zapier-platform pull`:\n\n* push to the promoted version\n* promote a new version\n* migrate users from one version to another\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform pull", "signature": "zapier-platform pull", "aliases": ["zapier pull"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "pull"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:push", "kind": "cli_function", "key": "push", "title": "zapier-platform push", "summary": "Build and upload the current integration.", "body": "# `push`\n\n> Build and upload the current integration.\n\n## High-level description\n\nBuild and upload the current integration.\n\n## Internals\n\nbuild then upload. --snapshot makes 0.0.0-LABEL for dev.\n\n## Typed inputs\n\n```ts\ntype Input = {\n disable_dependency_detection?: string | boolean; // `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry po\n skip_dep_install?: string | boolean; // `--skip-dep-install` | [alias: --skip-npm-install]\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n snapshot?: string | boolean; // `--snapshot` | Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be cr\n zapier_platform push?: string | boolean; // `zapier-platform push`\n zapier_platform push __snapshot MY_LABEL?: string | boolean; // `zapier-platform push --snapshot MY-LABEL`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform push`\n- Aliases: `zapier push`\n\n## Related functions\n\n- `build`\n- `upload`\n- `push`\n- `validate`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier push`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Build and upload the current integration.\n\n**Usage**: `zapier-platform push`\n\nThis command is the same as running `zapier-platform build` and `zapier-platform upload` in sequence. See those for more info.\n\n**Flags**\n* `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.\n* `--skip-dep-install` | [alias: --skip-npm-install]\nSkips installing a fresh copy of dependencies for shorter build time. Helpful for using yarn, pnpm, or local copies of dependencies.\n* `-d, --debug` | Show extra debugging output.\n* `--snapshot` | Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be created as: 0.0.0-MY-LABEL\n\n**Examples**\n* `zapier-platform push`\n* `zapier-platform push --snapshot MY-LABEL`\n\n## Examples\n\n```bash\n--disable-dependency-detection\n```\n```bash\n--skip-dep-install\n```\n```bash\n-d, --debug\n```\n```bash\n--snapshot\n```\n```bash\nzapier-platform push\n```\n```bash\nzapier-platform push --snapshot MY-LABEL\n```", "usage": "zapier-platform push", "signature": "zapier-platform push", "aliases": ["zapier push"], "flags": ["`--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.", "`--skip-dep-install` | [alias: --skip-npm-install]", "`-d, --debug` | Show extra debugging output.", "`--snapshot` | Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be created as: 0.0.0-MY-LABEL", "`zapier-platform push`", "`zapier-platform push --snapshot MY-LABEL`"], "args": [], "examples": ["--disable-dependency-detection", "--skip-dep-install", "-d, --debug", "--snapshot", "zapier-platform push", "zapier-platform push --snapshot MY-LABEL"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "push"], "related": ["build", "upload", "push", "validate"], "meta": {"surface": "platform_cli", "internals": "build then upload. --snapshot makes 0.0.0-LABEL for dev."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:push", "kind": "cli_command", "key": "push", "title": "zapier-platform push", "summary": "Build and upload the current integration.", "body": "# `push`\n\n> Build and upload the current integration.\n\n## High-level description\n\nBuild and upload the current integration.\n\n## Internals\n\nbuild then upload. --snapshot makes 0.0.0-LABEL for dev.\n\n## Typed inputs\n\n```ts\ntype Input = {\n disable_dependency_detection?: string | boolean; // `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry po\n skip_dep_install?: string | boolean; // `--skip-dep-install` | [alias: --skip-npm-install]\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n snapshot?: string | boolean; // `--snapshot` | Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be cr\n zapier_platform push?: string | boolean; // `zapier-platform push`\n zapier_platform push __snapshot MY_LABEL?: string | boolean; // `zapier-platform push --snapshot MY-LABEL`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform push`\n- Aliases: `zapier push`\n\n## Related functions\n\n- `build`\n- `upload`\n- `push`\n- `validate`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier push`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Build and upload the current integration.\n\n**Usage**: `zapier-platform push`\n\nThis command is the same as running `zapier-platform build` and `zapier-platform upload` in sequence. See those for more info.\n\n**Flags**\n* `--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.\n* `--skip-dep-install` | [alias: --skip-npm-install]\nSkips installing a fresh copy of dependencies for shorter build time. Helpful for using yarn, pnpm, or local copies of dependencies.\n* `-d, --debug` | Show extra debugging output.\n* `--snapshot` | Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be created as: 0.0.0-MY-LABEL\n\n**Examples**\n* `zapier-platform push`\n* `zapier-platform push --snapshot MY-LABEL`\n\n## Examples\n\n```bash\n--disable-dependency-detection\n```\n```bash\n--skip-dep-install\n```\n```bash\n-d, --debug\n```\n```bash\n--snapshot\n```\n```bash\nzapier-platform push\n```\n```bash\nzapier-platform push --snapshot MY-LABEL\n```", "usage": "zapier-platform push", "signature": "zapier-platform push", "aliases": ["zapier push"], "flags": ["`--disable-dependency-detection` | Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.", "`--skip-dep-install` | [alias: --skip-npm-install]", "`-d, --debug` | Show extra debugging output.", "`--snapshot` | Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be created as: 0.0.0-MY-LABEL", "`zapier-platform push`", "`zapier-platform push --snapshot MY-LABEL`"], "args": [], "examples": ["--disable-dependency-detection", "--skip-dep-install", "-d, --debug", "--snapshot", "zapier-platform push", "zapier-platform push --snapshot MY-LABEL"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "push"], "related": ["build", "upload", "push", "validate"], "meta": {"surface": "platform_cli", "internals": "build then upload. --snapshot makes 0.0.0-LABEL for dev."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:register", "kind": "cli_function", "key": "register", "title": "zapier-platform register", "summary": "Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.", "body": "# `register`\n\n> Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\n## High-level description\n\nRegister a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\n## Internals\n\nCreates the integration on developer.zapier.com and writes .zapierapprc.\n\n## Typed inputs\n\n```ts\ntype Input = {\n title?: string; // Your integration's public title. Asked interactively if not present.\n title?: string | boolean; // `title` | Your integration's public title. Asked interactively if not present.\n D, __desc?: string | boolean; // `-D, --desc` | A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and kee\n u, __url?: string | boolean; // `-u, --url` | The homepage URL of your app, e.g., https://example.com.\n a, __audience?: string | boolean; // `-a, --audience` | Are you building a public or private integration?\n r, __role?: string | boolean; // `-r, --role` | What is your relationship with the app you're integrating with Zapier?\n c, __category?: string | boolean; // `-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.\n s, __subscribe?: string | boolean; // `-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of yo\n y, __yes?: string | boolean; // `-y, --yes` | Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform register?: string | boolean; // `zapier-platform register`\n zapier_platform register \"My Cool Integration\"?: string | boolean; // `zapier-platform register \"My Cool Integration\"`\n zapier_platform register \"My Cool Integration\" __desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" __no_subscribe?: string | boolean; // `zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no\n zapier_platform register \"My Cool Integration\" __url \"https://www.zapier.com\" __audience private __role employee __category marketing_automation?: string | boolean; // `zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-autom\n zapier_platform register __subscribe?: string | boolean; // `zapier-platform register --subscribe`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform register [TITLE]`\n- Aliases: `zapier register`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier register`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\n**Usage**: `zapier-platform register [TITLE]`\n\nThis command creates a new integration and links it in the `./.zapierapprc` file. If `.zapierapprc` already exists, it will ask you if you want to update the currently-linked integration, as opposed to creating a new one.\n\nAfter registering a new integration, you can run `zapier-platform push` to build and upload your integration for use in the Zapier editor. This will change `.zapierapprc`, which identifies this directory as holding code for a specific integration.\n\n**Arguments**\n* `title` | Your integration's public title. Asked interactively if not present.\n\n**Flags**\n* `-D, --desc` | A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and keep projects on track.\"\n* `-u, --url` | The homepage URL of your app, e.g., https://example.com.\n* `-a, --audience` | Are you building a public or private integration?\n* `-r, --role` | What is your relationship with the app you're integrating with Zapier?\n* `-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.\n* `-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.\n* `-y, --yes` | Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if a .zapierapprc file is found.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform register`\n* `zapier-platform register \"My Cool Integration\"`\n* `zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe`\n* `zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation`\n* `zapier-platform register --subscribe`\n\n## Examples\n\n```bash\ntitle\n```\n```bash\n-D, --desc\n```\n```bash\n-u, --url\n```\n```bash\n-a, --audience\n```\n```bash\n-r, --role\n```\n```bash\n-c, --category\n```\n```bash\n-s, --subscribe\n```\n```bash\n-y, --yes\n```", "usage": "zapier-platform register [TITLE]", "signature": "zapier-platform register [TITLE]", "aliases": ["zapier register"], "flags": ["`title` | Your integration's public title. Asked interactively if not present.", "`-D, --desc` | A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and keep projects on track.\"", "`-u, --url` | The homepage URL of your app, e.g., https://example.com.", "`-a, --audience` | Are you building a public or private integration?", "`-r, --role` | What is your relationship with the app you're integrating with Zapier?", "`-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.", "`-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.", "`-y, --yes` | Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if a .zapierapprc file is found.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform register`", "`zapier-platform register \"My Cool Integration\"`", "`zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe`", "`zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation`", "`zapier-platform register --subscribe`"], "args": ["`title` | Your integration's public title. Asked interactively if not present."], "examples": ["title", "-D, --desc", "-u, --url", "-a, --audience", "-r, --role", "-c, --category", "-s, --subscribe", "-y, --yes", "-d, --debug", "zapier-platform register", "zapier-platform register \"My Cool Integration\"", "zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe", "zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation", "zapier-platform register --subscribe"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "register"], "related": [], "meta": {"surface": "platform_cli", "internals": "Creates the integration on developer.zapier.com and writes .zapierapprc."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:register", "kind": "cli_command", "key": "register", "title": "zapier-platform register", "summary": "Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.", "body": "# `register`\n\n> Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\n## High-level description\n\nRegister a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\n## Internals\n\nCreates the integration on developer.zapier.com and writes .zapierapprc.\n\n## Typed inputs\n\n```ts\ntype Input = {\n title?: string; // Your integration's public title. Asked interactively if not present.\n title?: string | boolean; // `title` | Your integration's public title. Asked interactively if not present.\n D, __desc?: string | boolean; // `-D, --desc` | A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and kee\n u, __url?: string | boolean; // `-u, --url` | The homepage URL of your app, e.g., https://example.com.\n a, __audience?: string | boolean; // `-a, --audience` | Are you building a public or private integration?\n r, __role?: string | boolean; // `-r, --role` | What is your relationship with the app you're integrating with Zapier?\n c, __category?: string | boolean; // `-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.\n s, __subscribe?: string | boolean; // `-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of yo\n y, __yes?: string | boolean; // `-y, --yes` | Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform register?: string | boolean; // `zapier-platform register`\n zapier_platform register \"My Cool Integration\"?: string | boolean; // `zapier-platform register \"My Cool Integration\"`\n zapier_platform register \"My Cool Integration\" __desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" __no_subscribe?: string | boolean; // `zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no\n zapier_platform register \"My Cool Integration\" __url \"https://www.zapier.com\" __audience private __role employee __category marketing_automation?: string | boolean; // `zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-autom\n zapier_platform register __subscribe?: string | boolean; // `zapier-platform register --subscribe`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform register [TITLE]`\n- Aliases: `zapier register`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier register`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\n**Usage**: `zapier-platform register [TITLE]`\n\nThis command creates a new integration and links it in the `./.zapierapprc` file. If `.zapierapprc` already exists, it will ask you if you want to update the currently-linked integration, as opposed to creating a new one.\n\nAfter registering a new integration, you can run `zapier-platform push` to build and upload your integration for use in the Zapier editor. This will change `.zapierapprc`, which identifies this directory as holding code for a specific integration.\n\n**Arguments**\n* `title` | Your integration's public title. Asked interactively if not present.\n\n**Flags**\n* `-D, --desc` | A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and keep projects on track.\"\n* `-u, --url` | The homepage URL of your app, e.g., https://example.com.\n* `-a, --audience` | Are you building a public or private integration?\n* `-r, --role` | What is your relationship with the app you're integrating with Zapier?\n* `-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.\n* `-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.\n* `-y, --yes` | Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if a .zapierapprc file is found.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform register`\n* `zapier-platform register \"My Cool Integration\"`\n* `zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe`\n* `zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation`\n* `zapier-platform register --subscribe`\n\n## Examples\n\n```bash\ntitle\n```\n```bash\n-D, --desc\n```\n```bash\n-u, --url\n```\n```bash\n-a, --audience\n```\n```bash\n-r, --role\n```\n```bash\n-c, --category\n```\n```bash\n-s, --subscribe\n```\n```bash\n-y, --yes\n```", "usage": "zapier-platform register [TITLE]", "signature": "zapier-platform register [TITLE]", "aliases": ["zapier register"], "flags": ["`title` | Your integration's public title. Asked interactively if not present.", "`-D, --desc` | A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and keep projects on track.\"", "`-u, --url` | The homepage URL of your app, e.g., https://example.com.", "`-a, --audience` | Are you building a public or private integration?", "`-r, --role` | What is your relationship with the app you're integrating with Zapier?", "`-c, --category` | How would you categorize your app? Choose the most appropriate option for your app's core features.", "`-s, --subscribe` | Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.", "`-y, --yes` | Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if a .zapierapprc file is found.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform register`", "`zapier-platform register \"My Cool Integration\"`", "`zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe`", "`zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation`", "`zapier-platform register --subscribe`"], "args": ["`title` | Your integration's public title. Asked interactively if not present."], "examples": ["title", "-D, --desc", "-u, --url", "-a, --audience", "-r, --role", "-c, --category", "-s, --subscribe", "-y, --yes", "-d, --debug", "zapier-platform register", "zapier-platform register \"My Cool Integration\"", "zapier-platform register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe", "zapier-platform register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation", "zapier-platform register --subscribe"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "register"], "related": [], "meta": {"surface": "platform_cli", "internals": "Creates the integration on developer.zapier.com and writes .zapierapprc."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:scaffold", "kind": "cli_function", "key": "scaffold", "title": "zapier-platform scaffold", "summary": "Add a starting trigger, create, search, or resource to your integration.", "body": "# `scaffold`\n\n> Add a starting trigger, create, search, or resource to your integration.\n\n## High-level description\n\nAdd a starting trigger, create, search, or resource to your integration.\n\n## Internals\n\nAST-edits index.js/ts to register a new trigger/search/create/resource file generated from packages/cli/scaffold templates.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // undefined\n required: string; // undefined\n triggers/contact.js?: string | boolean; // Creates a new file (such as `triggers/contact.js`)\n index.js?: string | boolean; // Imports and registers it inside your `index.js`\n actionType?: string | boolean; // (required) `actionType` | undefined\n noun?: string | boolean; // (required) `noun` | undefined\n d, __dest?: string | boolean; // `-d, --dest` | Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` i\n test_dest?: string | boolean; // `--test-dest` | Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/trigg\n e, __entry?: string | boolean; // `-e, --entry` | Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the \n f, __force?: string | boolean; // `-f, --force` | Should we overwrite an existing trigger/search/create file?\n no_help?: string | boolean; // `--no-help` | When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform scaffold trigger contact?: string | boolean; // `zapier-platform scaffold trigger contact`\n zapier_platform scaffold search contact __dest=my_src/searches?: string | boolean; // `zapier-platform scaffold search contact --dest=my_src/searches`\n zapier_platform scaffold create contact __entry=src/index.js?: string | boolean; // `zapier-platform scaffold create contact --entry=src/index.js`\n zapier_platform scaffold resource contact __force?: string | boolean; // `zapier-platform scaffold resource contact --force`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform scaffold ACTIONTYPE NOUN`\n- Aliases: `zapier scaffold`\n\n## Related functions\n\n- `init`\n- `scaffold`\n- `convert`\n- `register`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier scaffold`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Add a starting trigger, create, search, or resource to your integration.\n\n**Usage**: `zapier-platform scaffold ACTIONTYPE NOUN`\n\nThe first argument should be one of `trigger|search|create|resource` followed by the noun that this will act on (something like \"contact\" or \"deal\").\n\nThe scaffold command does two general things:\n\n* Creates a new file (such as `triggers/contact.js`)\n* Imports and registers it inside your `index.js`\n\nYou can mix and match several options to customize the created scaffold for your project.\n\n**Arguments**\n* (required) `actionType` | undefined\n* (required) `noun` | undefined\n\n**Flags**\n* `-d, --dest` | Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `[triggers|searches|creates]/{noun}`.\n* `--test-dest` | Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `test/[triggers|searches|creates]/{noun}`.\n* `-e, --entry` | Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the correct file if not provided.\n* `-f, --force` | Should we overwrite an existing trigger/search/create file?\n* `--no-help` | When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform scaffold trigger contact`\n* `zapier-platform scaffold search contact --dest=my_src/searches`\n* `zapier-platform scaffold create contact --entry=src/index.js`\n* `zapier-platform scaffold resource contact --force`\n\n## Examples\n\n```bash\n-d, --dest\n```\n```bash\n--test-dest\n```\n```bash\n-e, --entry\n```\n```bash\n-f, --force\n```\n```bash\n--no-help\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform scaffold trigger contact\n```\n```bash\nzapier-platform scaffold search contact --dest=my_src/searches\n```", "usage": "zapier-platform scaffold ACTIONTYPE NOUN", "signature": "zapier-platform scaffold ACTIONTYPE NOUN", "aliases": ["zapier scaffold"], "flags": ["Creates a new file (such as `triggers/contact.js`)", "Imports and registers it inside your `index.js`", "(required) `actionType` | undefined", "(required) `noun` | undefined", "`-d, --dest` | Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `[triggers|searches|creates]/{noun}`.", "`--test-dest` | Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `test/[triggers|searches|creates]/{noun}`.", "`-e, --entry` | Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the correct file if not provided.", "`-f, --force` | Should we overwrite an existing trigger/search/create file?", "`--no-help` | When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform scaffold trigger contact`", "`zapier-platform scaffold search contact --dest=my_src/searches`", "`zapier-platform scaffold create contact --entry=src/index.js`", "`zapier-platform scaffold resource contact --force`"], "args": ["(required) `actionType` | undefined", "(required) `noun` | undefined"], "examples": ["-d, --dest", "--test-dest", "-e, --entry", "-f, --force", "--no-help", "-d, --debug", "zapier-platform scaffold trigger contact", "zapier-platform scaffold search contact --dest=my_src/searches", "zapier-platform scaffold create contact --entry=src/index.js", "zapier-platform scaffold resource contact --force"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "scaffold"], "related": ["init", "scaffold", "convert", "register"], "meta": {"surface": "platform_cli", "internals": "AST-edits index.js/ts to register a new trigger/search/create/resource file generated from packages/cli/scaffold templates."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:scaffold", "kind": "cli_command", "key": "scaffold", "title": "zapier-platform scaffold", "summary": "Add a starting trigger, create, search, or resource to your integration.", "body": "# `scaffold`\n\n> Add a starting trigger, create, search, or resource to your integration.\n\n## High-level description\n\nAdd a starting trigger, create, search, or resource to your integration.\n\n## Internals\n\nAST-edits index.js/ts to register a new trigger/search/create/resource file generated from packages/cli/scaffold templates.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // undefined\n required: string; // undefined\n triggers/contact.js?: string | boolean; // Creates a new file (such as `triggers/contact.js`)\n index.js?: string | boolean; // Imports and registers it inside your `index.js`\n actionType?: string | boolean; // (required) `actionType` | undefined\n noun?: string | boolean; // (required) `noun` | undefined\n d, __dest?: string | boolean; // `-d, --dest` | Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` i\n test_dest?: string | boolean; // `--test-dest` | Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/trigg\n e, __entry?: string | boolean; // `-e, --entry` | Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the \n f, __force?: string | boolean; // `-f, --force` | Should we overwrite an existing trigger/search/create file?\n no_help?: string | boolean; // `--no-help` | When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform scaffold trigger contact?: string | boolean; // `zapier-platform scaffold trigger contact`\n zapier_platform scaffold search contact __dest=my_src/searches?: string | boolean; // `zapier-platform scaffold search contact --dest=my_src/searches`\n zapier_platform scaffold create contact __entry=src/index.js?: string | boolean; // `zapier-platform scaffold create contact --entry=src/index.js`\n zapier_platform scaffold resource contact __force?: string | boolean; // `zapier-platform scaffold resource contact --force`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform scaffold ACTIONTYPE NOUN`\n- Aliases: `zapier scaffold`\n\n## Related functions\n\n- `init`\n- `scaffold`\n- `convert`\n- `register`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier scaffold`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Add a starting trigger, create, search, or resource to your integration.\n\n**Usage**: `zapier-platform scaffold ACTIONTYPE NOUN`\n\nThe first argument should be one of `trigger|search|create|resource` followed by the noun that this will act on (something like \"contact\" or \"deal\").\n\nThe scaffold command does two general things:\n\n* Creates a new file (such as `triggers/contact.js`)\n* Imports and registers it inside your `index.js`\n\nYou can mix and match several options to customize the created scaffold for your project.\n\n**Arguments**\n* (required) `actionType` | undefined\n* (required) `noun` | undefined\n\n**Flags**\n* `-d, --dest` | Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `[triggers|searches|creates]/{noun}`.\n* `--test-dest` | Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `test/[triggers|searches|creates]/{noun}`.\n* `-e, --entry` | Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the correct file if not provided.\n* `-f, --force` | Should we overwrite an existing trigger/search/create file?\n* `--no-help` | When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform scaffold trigger contact`\n* `zapier-platform scaffold search contact --dest=my_src/searches`\n* `zapier-platform scaffold create contact --entry=src/index.js`\n* `zapier-platform scaffold resource contact --force`\n\n## Examples\n\n```bash\n-d, --dest\n```\n```bash\n--test-dest\n```\n```bash\n-e, --entry\n```\n```bash\n-f, --force\n```\n```bash\n--no-help\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform scaffold trigger contact\n```\n```bash\nzapier-platform scaffold search contact --dest=my_src/searches\n```", "usage": "zapier-platform scaffold ACTIONTYPE NOUN", "signature": "zapier-platform scaffold ACTIONTYPE NOUN", "aliases": ["zapier scaffold"], "flags": ["Creates a new file (such as `triggers/contact.js`)", "Imports and registers it inside your `index.js`", "(required) `actionType` | undefined", "(required) `noun` | undefined", "`-d, --dest` | Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `[triggers|searches|creates]/{noun}`.", "`--test-dest` | Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `test/[triggers|searches|creates]/{noun}`.", "`-e, --entry` | Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the correct file if not provided.", "`-f, --force` | Should we overwrite an existing trigger/search/create file?", "`--no-help` | When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform scaffold trigger contact`", "`zapier-platform scaffold search contact --dest=my_src/searches`", "`zapier-platform scaffold create contact --entry=src/index.js`", "`zapier-platform scaffold resource contact --force`"], "args": ["(required) `actionType` | undefined", "(required) `noun` | undefined"], "examples": ["-d, --dest", "--test-dest", "-e, --entry", "-f, --force", "--no-help", "-d, --debug", "zapier-platform scaffold trigger contact", "zapier-platform scaffold search contact --dest=my_src/searches", "zapier-platform scaffold create contact --entry=src/index.js", "zapier-platform scaffold resource contact --force"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "scaffold"], "related": ["init", "scaffold", "convert", "register"], "meta": {"surface": "platform_cli", "internals": "AST-edits index.js/ts to register a new trigger/search/create/resource file generated from packages/cli/scaffold templates."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:team:add", "kind": "cli_function", "key": "team:add", "title": "zapier-platform team:add", "summary": "Add a team member to your integration.", "body": "# `team:add`\n\n> Add a team member to your integration.\n\n## High-level description\n\nAdd a team member to your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n required: string; // The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app \n message?: string; // A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.\n email?: string | boolean; // (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n role?: string | boolean; // (required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have rea\n message?: string | boolean; // `message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform team:add bruce@wayne.com admin?: string | boolean; // `zapier-platform team:add bruce@wayne.com admin`\n zapier_platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"?: string | boolean; // `zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"`\n zapier_platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"?: string | boolean; // `zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"`\n team:invite?: string | boolean; // `team:invite`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform team:add EMAIL ROLE [MESSAGE]`\n- Aliases: `team:invite`, `zapier team:add`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier team:add`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Add a team member to your integration.\n\n**Usage**: `zapier-platform team:add EMAIL ROLE [MESSAGE]`\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nTeam members can be freely added and removed.\n\n**Arguments**\n* (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n* (required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.\n* `message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform team:add bruce@wayne.com admin`\n* `zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"`\n* `zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"`\n\n**Aliases**\n* `team:invite`\n\n## Examples\n\n```bash\nmessage\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform team:add bruce@wayne.com admin\n```\n```bash\nzapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"\n```\n```bash\nzapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"\n```\n```bash\nteam:invite\n```", "usage": "zapier-platform team:add EMAIL ROLE [MESSAGE]", "signature": "zapier-platform team:add EMAIL ROLE [MESSAGE]", "aliases": ["team:invite", "zapier team:add"], "flags": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "(required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.", "`message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform team:add bruce@wayne.com admin`", "`zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"`", "`zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"`", "`team:invite`"], "args": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "(required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.", "`message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved."], "examples": ["message", "-d, --debug", "zapier-platform team:add bruce@wayne.com admin", "zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"", "zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"", "team:invite"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "team"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:team:add", "kind": "cli_command", "key": "team:add", "title": "zapier-platform team:add", "summary": "Add a team member to your integration.", "body": "# `team:add`\n\n> Add a team member to your integration.\n\n## High-level description\n\nAdd a team member to your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n required: string; // The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app \n message?: string; // A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.\n email?: string | boolean; // (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n role?: string | boolean; // (required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have rea\n message?: string | boolean; // `message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform team:add bruce@wayne.com admin?: string | boolean; // `zapier-platform team:add bruce@wayne.com admin`\n zapier_platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"?: string | boolean; // `zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"`\n zapier_platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"?: string | boolean; // `zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"`\n team:invite?: string | boolean; // `team:invite`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform team:add EMAIL ROLE [MESSAGE]`\n- Aliases: `team:invite`, `zapier team:add`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier team:add`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Add a team member to your integration.\n\n**Usage**: `zapier-platform team:add EMAIL ROLE [MESSAGE]`\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nTeam members can be freely added and removed.\n\n**Arguments**\n* (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n* (required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.\n* `message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform team:add bruce@wayne.com admin`\n* `zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"`\n* `zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"`\n\n**Aliases**\n* `team:invite`\n\n## Examples\n\n```bash\nmessage\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform team:add bruce@wayne.com admin\n```\n```bash\nzapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"\n```\n```bash\nzapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"\n```\n```bash\nteam:invite\n```", "usage": "zapier-platform team:add EMAIL ROLE [MESSAGE]", "signature": "zapier-platform team:add EMAIL ROLE [MESSAGE]", "aliases": ["team:invite", "zapier team:add"], "flags": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "(required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.", "`message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform team:add bruce@wayne.com admin`", "`zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"`", "`zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"`", "`team:invite`"], "args": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "(required) `role` | The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.", "`message` | A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved."], "examples": ["message", "-d, --debug", "zapier-platform team:add bruce@wayne.com admin", "zapier-platform team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"", "zapier-platform team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\"", "team:invite"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "team"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:team:get", "kind": "cli_function", "key": "team:get", "title": "zapier-platform team:get", "summary": "Get team members involved with your integration.", "body": "# `team:get`\n\n> Get team members involved with your integration.\n\n## High-level description\n\nGet team members involved with your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n team:list?: string | boolean; // `team:list`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform team:get`\n- Aliases: `team:list`, `zapier team:get`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier team:get`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get team members involved with your integration.\n\n**Usage**: `zapier-platform team:get`\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nUse the `zapier-platform team:add` and `zapier-platform team:remove` commands to modify your team.\n\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Aliases**\n* `team:list`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nteam:list\n```", "usage": "zapier-platform team:get", "signature": "zapier-platform team:get", "aliases": ["team:list", "zapier team:get"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`team:list`"], "args": [], "examples": ["-d, --debug", "-f, --format", "team:list"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "team"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:team:get", "kind": "cli_command", "key": "team:get", "title": "zapier-platform team:get", "summary": "Get team members involved with your integration.", "body": "# `team:get`\n\n> Get team members involved with your integration.\n\n## High-level description\n\nGet team members involved with your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n team:list?: string | boolean; // `team:list`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform team:get`\n- Aliases: `team:list`, `zapier team:get`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier team:get`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get team members involved with your integration.\n\n**Usage**: `zapier-platform team:get`\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nUse the `zapier-platform team:add` and `zapier-platform team:remove` commands to modify your team.\n\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Aliases**\n* `team:list`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nteam:list\n```", "usage": "zapier-platform team:get", "signature": "zapier-platform team:get", "aliases": ["team:list", "zapier team:get"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`team:list`"], "args": [], "examples": ["-d, --debug", "-f, --format", "team:list"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "team"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:team:remove", "kind": "cli_function", "key": "team:remove", "title": "zapier-platform team:remove", "summary": "Remove a team member from all versions of your integration.", "body": "# `team:remove`\n\n> Remove a team member from all versions of your integration.\n\n## High-level description\n\nRemove a team member from all versions of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n team:delete?: string | boolean; // `team:delete`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform team:remove`\n- Aliases: `team:delete`, `zapier team:remove`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier team:remove`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Remove a team member from all versions of your integration.\n\n**Usage**: `zapier-platform team:remove`\n\nAdmins will immediately lose write access to the integration.\nCollaborators will immediately lose read access to the integration.\nSubscribers won't receive future email updates.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n**Aliases**\n* `team:delete`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\nteam:delete\n```", "usage": "zapier-platform team:remove", "signature": "zapier-platform team:remove", "aliases": ["team:delete", "zapier team:remove"], "flags": ["`-d, --debug` | Show extra debugging output.", "`team:delete`"], "args": [], "examples": ["-d, --debug", "team:delete"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "team"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:team:remove", "kind": "cli_command", "key": "team:remove", "title": "zapier-platform team:remove", "summary": "Remove a team member from all versions of your integration.", "body": "# `team:remove`\n\n> Remove a team member from all versions of your integration.\n\n## High-level description\n\nRemove a team member from all versions of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n team:delete?: string | boolean; // `team:delete`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform team:remove`\n- Aliases: `team:delete`, `zapier team:remove`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier team:remove`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Remove a team member from all versions of your integration.\n\n**Usage**: `zapier-platform team:remove`\n\nAdmins will immediately lose write access to the integration.\nCollaborators will immediately lose read access to the integration.\nSubscribers won't receive future email updates.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n**Aliases**\n* `team:delete`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\nteam:delete\n```", "usage": "zapier-platform team:remove", "signature": "zapier-platform team:remove", "aliases": ["team:delete", "zapier team:remove"], "flags": ["`-d, --debug` | Show extra debugging output.", "`team:delete`"], "args": [], "examples": ["-d, --debug", "team:delete"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "team"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:test", "kind": "cli_function", "key": "test", "title": "zapier-platform test", "summary": "Test your integration via the \"test\" script in your \"package.json\".", "body": "# `test`\n\n> Test your integration via the \"test\" script in your \"package.json\".\n\n## High-level description\n\nTest your integration via the \"test\" script in your \"package.json\".\n\n## Internals\n\nWrapper around npm/yarn/pnpm test after validate + env inject.\n\n## Typed inputs\n\n```ts\ntype Input = {\n skip_validate?: string | boolean; // `--skip-validate` | Forgo running `zapier-platform validate` before tests are run. This will speed up tests if you're modifying functionalit\n yarn?: string | boolean; // `--yarn` | Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you r\n pnpm?: string | boolean; // `--pnpm` | Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if \n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform test?: string | boolean; // `zapier-platform test`\n zapier_platform test __skip_validate __ _t 30000 __grep api?: string | boolean; // `zapier-platform test --skip-validate -- -t 30000 --grep api`\n zapier_platform test __ _fo __testNamePattern \"auth pass\"?: string | boolean; // `zapier-platform test -- -fo --testNamePattern \"auth pass\"`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform test`\n- Aliases: `zapier test`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier test`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Test your integration via the \"test\" script in your \"package.json\".\n\n**Usage**: `zapier-platform test`\n\nThis command is a wrapper around `npm test` that also validates the structure of your integration and sets up extra environment variables.\n\nYou can pass any args/flags after a `--`; they will get forwarded onto your test script.\n\n**Flags**\n* `--skip-validate` | Forgo running `zapier-platform validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.\n* `--yarn` | Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.\n* `--pnpm` | Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform test`\n* `zapier-platform test --skip-validate -- -t 30000 --grep api`\n* `zapier-platform test -- -fo --testNamePattern \"auth pass\"`\n\n## Examples\n\n```bash\n--skip-validate\n```\n```bash\n--yarn\n```\n```bash\n--pnpm\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform test\n```\n```bash\nzapier-platform test --skip-validate -- -t 30000 --grep api\n```\n```bash\nzapier-platform test -- -fo --testNamePattern \"auth pass\"\n```", "usage": "zapier-platform test", "signature": "zapier-platform test", "aliases": ["zapier test"], "flags": ["`--skip-validate` | Forgo running `zapier-platform validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.", "`--yarn` | Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.", "`--pnpm` | Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform test`", "`zapier-platform test --skip-validate -- -t 30000 --grep api`", "`zapier-platform test -- -fo --testNamePattern \"auth pass\"`"], "args": [], "examples": ["--skip-validate", "--yarn", "--pnpm", "-d, --debug", "zapier-platform test", "zapier-platform test --skip-validate -- -t 30000 --grep api", "zapier-platform test -- -fo --testNamePattern \"auth pass\""], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "test"], "related": [], "meta": {"surface": "platform_cli", "internals": "Wrapper around npm/yarn/pnpm test after validate + env inject."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:test", "kind": "cli_command", "key": "test", "title": "zapier-platform test", "summary": "Test your integration via the \"test\" script in your \"package.json\".", "body": "# `test`\n\n> Test your integration via the \"test\" script in your \"package.json\".\n\n## High-level description\n\nTest your integration via the \"test\" script in your \"package.json\".\n\n## Internals\n\nWrapper around npm/yarn/pnpm test after validate + env inject.\n\n## Typed inputs\n\n```ts\ntype Input = {\n skip_validate?: string | boolean; // `--skip-validate` | Forgo running `zapier-platform validate` before tests are run. This will speed up tests if you're modifying functionalit\n yarn?: string | boolean; // `--yarn` | Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you r\n pnpm?: string | boolean; // `--pnpm` | Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if \n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform test?: string | boolean; // `zapier-platform test`\n zapier_platform test __skip_validate __ _t 30000 __grep api?: string | boolean; // `zapier-platform test --skip-validate -- -t 30000 --grep api`\n zapier_platform test __ _fo __testNamePattern \"auth pass\"?: string | boolean; // `zapier-platform test -- -fo --testNamePattern \"auth pass\"`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform test`\n- Aliases: `zapier test`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier test`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Test your integration via the \"test\" script in your \"package.json\".\n\n**Usage**: `zapier-platform test`\n\nThis command is a wrapper around `npm test` that also validates the structure of your integration and sets up extra environment variables.\n\nYou can pass any args/flags after a `--`; they will get forwarded onto your test script.\n\n**Flags**\n* `--skip-validate` | Forgo running `zapier-platform validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.\n* `--yarn` | Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.\n* `--pnpm` | Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform test`\n* `zapier-platform test --skip-validate -- -t 30000 --grep api`\n* `zapier-platform test -- -fo --testNamePattern \"auth pass\"`\n\n## Examples\n\n```bash\n--skip-validate\n```\n```bash\n--yarn\n```\n```bash\n--pnpm\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform test\n```\n```bash\nzapier-platform test --skip-validate -- -t 30000 --grep api\n```\n```bash\nzapier-platform test -- -fo --testNamePattern \"auth pass\"\n```", "usage": "zapier-platform test", "signature": "zapier-platform test", "aliases": ["zapier test"], "flags": ["`--skip-validate` | Forgo running `zapier-platform validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.", "`--yarn` | Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.", "`--pnpm` | Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform test`", "`zapier-platform test --skip-validate -- -t 30000 --grep api`", "`zapier-platform test -- -fo --testNamePattern \"auth pass\"`"], "args": [], "examples": ["--skip-validate", "--yarn", "--pnpm", "-d, --debug", "zapier-platform test", "zapier-platform test --skip-validate -- -t 30000 --grep api", "zapier-platform test -- -fo --testNamePattern \"auth pass\""], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "test"], "related": [], "meta": {"surface": "platform_cli", "internals": "Wrapper around npm/yarn/pnpm test after validate + env inject."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:upload", "kind": "cli_function", "key": "upload", "title": "zapier-platform upload", "summary": "Upload the latest build of your integration to Zapier.", "body": "# `upload`\n\n> Upload the latest build of your integration to Zapier.\n\n## High-level description\n\nUpload the latest build of your integration to Zapier.\n\n## Internals\n\nPOSTs build.zip + source.zip for the version in package.json. Versions must be sequential.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform upload`\n- Aliases: `zapier upload`\n\n## Related functions\n\n- `build`\n- `upload`\n- `push`\n- `validate`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier upload`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Upload the latest build of your integration to Zapier.\n\n**Usage**: `zapier-platform upload`\n\nThis command sends both build/build.zip and build/source.zip to Zapier for use.\n\nTypically we recommend using `zapier-platform push`, which does a build and upload, rather than `upload` by itself.\n\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform upload", "signature": "zapier-platform upload", "aliases": ["zapier upload"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "upload"], "related": ["build", "upload", "push", "validate"], "meta": {"surface": "platform_cli", "internals": "POSTs build.zip + source.zip for the version in package.json. Versions must be sequential."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:upload", "kind": "cli_command", "key": "upload", "title": "zapier-platform upload", "summary": "Upload the latest build of your integration to Zapier.", "body": "# `upload`\n\n> Upload the latest build of your integration to Zapier.\n\n## High-level description\n\nUpload the latest build of your integration to Zapier.\n\n## Internals\n\nPOSTs build.zip + source.zip for the version in package.json. Versions must be sequential.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform upload`\n- Aliases: `zapier upload`\n\n## Related functions\n\n- `build`\n- `upload`\n- `push`\n- `validate`\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier upload`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Upload the latest build of your integration to Zapier.\n\n**Usage**: `zapier-platform upload`\n\nThis command sends both build/build.zip and build/source.zip to Zapier for use.\n\nTypically we recommend using `zapier-platform push`, which does a build and upload, rather than `upload` by itself.\n\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n\n## Examples\n\n```bash\n-d, --debug\n```", "usage": "zapier-platform upload", "signature": "zapier-platform upload", "aliases": ["zapier upload"], "flags": ["`-d, --debug` | Show extra debugging output."], "args": [], "examples": ["-d, --debug"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "upload"], "related": ["build", "upload", "push", "validate"], "meta": {"surface": "platform_cli", "internals": "POSTs build.zip + source.zip for the version in package.json. Versions must be sequential."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:users:add", "kind": "cli_function", "key": "users:add", "title": "zapier-platform users:add", "summary": "Add a user to some or all versions of your integration.", "body": "# `users:add`\n\n> Add a user to some or all versions of your integration.\n\n## High-level description\n\nAdd a user to some or all versions of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n version?: string; // A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.\n email?: string | boolean; // (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n version?: string | boolean; // `version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.\n f, __force?: string | boolean; // `-f, --force` | Skip confirmation. Useful for running programatically.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform users:add bruce@wayne.com?: string | boolean; // `zapier-platform users:add bruce@wayne.com`\n zapier_platform users:add alfred@wayne.com 1.2.3?: string | boolean; // `zapier-platform users:add alfred@wayne.com 1.2.3`\n users:invite?: string | boolean; // `users:invite`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:add EMAIL [VERSION]`\n- Aliases: `users:invite`, `zapier users:add`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:add`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Add a user to some or all versions of your integration.\n\n**Usage**: `zapier-platform users:add EMAIL [VERSION]`\n\nWhen this command is run, we'll send an email to the user inviting them to try your integration. You can track the status of that invite using the `zapier-platform users:get` command.\n\nInvited users will be able to see your integration's name, logo, and description. They'll also be able to create Zaps using any available triggers and actions.\n\n**Arguments**\n* (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n* `version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.\n\n**Flags**\n* `-f, --force` | Skip confirmation. Useful for running programatically.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform users:add bruce@wayne.com`\n* `zapier-platform users:add alfred@wayne.com 1.2.3`\n\n**Aliases**\n* `users:invite`\n\n## Examples\n\n```bash\nversion\n```\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform users:add bruce@wayne.com\n```\n```bash\nzapier-platform users:add alfred@wayne.com 1.2.3\n```\n```bash\nusers:invite\n```", "usage": "zapier-platform users:add EMAIL [VERSION]", "signature": "zapier-platform users:add EMAIL [VERSION]", "aliases": ["users:invite", "zapier users:add"], "flags": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "`version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.", "`-f, --force` | Skip confirmation. Useful for running programatically.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform users:add bruce@wayne.com`", "`zapier-platform users:add alfred@wayne.com 1.2.3`", "`users:invite`"], "args": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "`version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions."], "examples": ["version", "-f, --force", "-d, --debug", "zapier-platform users:add bruce@wayne.com", "zapier-platform users:add alfred@wayne.com 1.2.3", "users:invite"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:users:add", "kind": "cli_command", "key": "users:add", "title": "zapier-platform users:add", "summary": "Add a user to some or all versions of your integration.", "body": "# `users:add`\n\n> Add a user to some or all versions of your integration.\n\n## High-level description\n\nAdd a user to some or all versions of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n version?: string; // A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.\n email?: string | boolean; // (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n version?: string | boolean; // `version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.\n f, __force?: string | boolean; // `-f, --force` | Skip confirmation. Useful for running programatically.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n zapier_platform users:add bruce@wayne.com?: string | boolean; // `zapier-platform users:add bruce@wayne.com`\n zapier_platform users:add alfred@wayne.com 1.2.3?: string | boolean; // `zapier-platform users:add alfred@wayne.com 1.2.3`\n users:invite?: string | boolean; // `users:invite`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:add EMAIL [VERSION]`\n- Aliases: `users:invite`, `zapier users:add`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:add`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Add a user to some or all versions of your integration.\n\n**Usage**: `zapier-platform users:add EMAIL [VERSION]`\n\nWhen this command is run, we'll send an email to the user inviting them to try your integration. You can track the status of that invite using the `zapier-platform users:get` command.\n\nInvited users will be able to see your integration's name, logo, and description. They'll also be able to create Zaps using any available triggers and actions.\n\n**Arguments**\n* (required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.\n* `version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.\n\n**Flags**\n* `-f, --force` | Skip confirmation. Useful for running programatically.\n* `-d, --debug` | Show extra debugging output.\n\n**Examples**\n* `zapier-platform users:add bruce@wayne.com`\n* `zapier-platform users:add alfred@wayne.com 1.2.3`\n\n**Aliases**\n* `users:invite`\n\n## Examples\n\n```bash\nversion\n```\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nzapier-platform users:add bruce@wayne.com\n```\n```bash\nzapier-platform users:add alfred@wayne.com 1.2.3\n```\n```bash\nusers:invite\n```", "usage": "zapier-platform users:add EMAIL [VERSION]", "signature": "zapier-platform users:add EMAIL [VERSION]", "aliases": ["users:invite", "zapier users:add"], "flags": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "`version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.", "`-f, --force` | Skip confirmation. Useful for running programatically.", "`-d, --debug` | Show extra debugging output.", "`zapier-platform users:add bruce@wayne.com`", "`zapier-platform users:add alfred@wayne.com 1.2.3`", "`users:invite`"], "args": ["(required) `email` | The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.", "`version` | A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions."], "examples": ["version", "-f, --force", "-d, --debug", "zapier-platform users:add bruce@wayne.com", "zapier-platform users:add alfred@wayne.com 1.2.3", "users:invite"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:users:get", "kind": "cli_function", "key": "users:get", "title": "zapier-platform users:get", "summary": "Get a list of users who have been invited to your integration.", "body": "# `users:get`\n\n> Get a list of users who have been invited to your integration.\n\n## High-level description\n\nGet a list of users who have been invited to your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n users:list?: string | boolean; // `users:list`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:get`\n- Aliases: `users:list`, `zapier users:get`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:get`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get a list of users who have been invited to your integration.\n\n**Usage**: `zapier-platform users:get`\n\nNote that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the `zapier-platform users:add` command or the web UI). Users who joined by clicking links generated using the `zapier-platform user:links` command won't show up here.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Aliases**\n* `users:list`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nusers:list\n```", "usage": "zapier-platform users:get", "signature": "zapier-platform users:get", "aliases": ["users:list", "zapier users:get"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`users:list`"], "args": [], "examples": ["-d, --debug", "-f, --format", "users:list"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:users:get", "kind": "cli_command", "key": "users:get", "title": "zapier-platform users:get", "summary": "Get a list of users who have been invited to your integration.", "body": "# `users:get`\n\n> Get a list of users who have been invited to your integration.\n\n## High-level description\n\nGet a list of users who have been invited to your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n users:list?: string | boolean; // `users:list`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:get`\n- Aliases: `users:list`, `zapier users:get`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:get`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get a list of users who have been invited to your integration.\n\n**Usage**: `zapier-platform users:get`\n\nNote that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the `zapier-platform users:add` command or the web UI). Users who joined by clicking links generated using the `zapier-platform user:links` command won't show up here.\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Aliases**\n* `users:list`\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nusers:list\n```", "usage": "zapier-platform users:get", "signature": "zapier-platform users:get", "aliases": ["users:list", "zapier users:get"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`users:list`"], "args": [], "examples": ["-d, --debug", "-f, --format", "users:list"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:users:links", "kind": "cli_function", "key": "users:links", "title": "zapier-platform users:links", "summary": "Get a list of links that are used to invite users to your integration.", "body": "# `users:links`\n\n> Get a list of links that are used to invite users to your integration.\n\n## High-level description\n\nGet a list of links that are used to invite users to your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:links`\n- Aliases: `zapier users:links`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:links`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get a list of links that are used to invite users to your integration.\n\n**Usage**: `zapier-platform users:links`\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform users:links", "signature": "zapier-platform users:links", "aliases": ["zapier users:links"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:users:links", "kind": "cli_command", "key": "users:links", "title": "zapier-platform users:links", "summary": "Get a list of links that are used to invite users to your integration.", "body": "# `users:links`\n\n> Get a list of links that are used to invite users to your integration.\n\n## High-level description\n\nGet a list of links that are used to invite users to your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:links`\n- Aliases: `zapier users:links`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:links`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Get a list of links that are used to invite users to your integration.\n\n**Usage**: `zapier-platform users:links`\n\n**Flags**\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform users:links", "signature": "zapier-platform users:links", "aliases": ["zapier users:links"], "flags": ["`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:users:remove", "kind": "cli_function", "key": "users:remove", "title": "zapier-platform users:remove", "summary": "Remove a user from all versions of your integration.", "body": "# `users:remove`\n\n> Remove a user from all versions of your integration.\n\n## High-level description\n\nRemove a user from all versions of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The user to be removed.\n email?: string | boolean; // (required) `email` | The user to be removed.\n f, __force?: string | boolean; // `-f, --force` | Skips confirmation. Useful for running programatically.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n users:delete?: string | boolean; // `users:delete`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:remove EMAIL`\n- Aliases: `users:delete`, `zapier users:remove`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:remove`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Remove a user from all versions of your integration.\n\n**Usage**: `zapier-platform users:remove EMAIL`\n\nWhen this command is run, their Zaps will immediately turn off. They won't be able to use your app again until they're re-invited or it has gone public. In practice, this command isn't run often as it's very disruptive to users.\n\n**Arguments**\n* (required) `email` | The user to be removed.\n\n**Flags**\n* `-f, --force` | Skips confirmation. Useful for running programatically.\n* `-d, --debug` | Show extra debugging output.\n\n**Aliases**\n* `users:delete`\n\n## Examples\n\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nusers:delete\n```", "usage": "zapier-platform users:remove EMAIL", "signature": "zapier-platform users:remove EMAIL", "aliases": ["users:delete", "zapier users:remove"], "flags": ["(required) `email` | The user to be removed.", "`-f, --force` | Skips confirmation. Useful for running programatically.", "`-d, --debug` | Show extra debugging output.", "`users:delete`"], "args": ["(required) `email` | The user to be removed."], "examples": ["-f, --force", "-d, --debug", "users:delete"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:users:remove", "kind": "cli_command", "key": "users:remove", "title": "zapier-platform users:remove", "summary": "Remove a user from all versions of your integration.", "body": "# `users:remove`\n\n> Remove a user from all versions of your integration.\n\n## High-level description\n\nRemove a user from all versions of your integration.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n required: string; // The user to be removed.\n email?: string | boolean; // (required) `email` | The user to be removed.\n f, __force?: string | boolean; // `-f, --force` | Skips confirmation. Useful for running programatically.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n users:delete?: string | boolean; // `users:delete`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform users:remove EMAIL`\n- Aliases: `users:delete`, `zapier users:remove`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier users:remove`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Remove a user from all versions of your integration.\n\n**Usage**: `zapier-platform users:remove EMAIL`\n\nWhen this command is run, their Zaps will immediately turn off. They won't be able to use your app again until they're re-invited or it has gone public. In practice, this command isn't run often as it's very disruptive to users.\n\n**Arguments**\n* (required) `email` | The user to be removed.\n\n**Flags**\n* `-f, --force` | Skips confirmation. Useful for running programatically.\n* `-d, --debug` | Show extra debugging output.\n\n**Aliases**\n* `users:delete`\n\n## Examples\n\n```bash\n-f, --force\n```\n```bash\n-d, --debug\n```\n```bash\nusers:delete\n```", "usage": "zapier-platform users:remove EMAIL", "signature": "zapier-platform users:remove EMAIL", "aliases": ["users:delete", "zapier users:remove"], "flags": ["(required) `email` | The user to be removed.", "`-f, --force` | Skips confirmation. Useful for running programatically.", "`-d, --debug` | Show extra debugging output.", "`users:delete`"], "args": ["(required) `email` | The user to be removed."], "examples": ["-f, --force", "-d, --debug", "users:delete"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "users"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:validate", "kind": "cli_function", "key": "validate", "title": "zapier-platform validate", "summary": "Validate your integration.", "body": "# `validate`\n\n> Validate your integration.\n\n## High-level description\n\nValidate your integration.\n\n## Internals\n\nRuns zapier-platform-schema JSON Schema plus optional live style checks against Zapier's servers.\n\n## Typed inputs\n\n```ts\ntype Input = {\n without_style?: string | boolean; // `--without-style` | Forgo pinging the Zapier server to run further checks.\n skip_build?: string | boolean; // `--skip-build` | Skip running the _zapier-build script before validation.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform validate?: string | boolean; // `zapier-platform validate`\n zapier_platform validate __without_style?: string | boolean; // `zapier-platform validate --without-style`\n zapier_platform validate __skip_build?: string | boolean; // `zapier-platform validate --skip-build`\n zapier_platform validate __format json?: string | boolean; // `zapier-platform validate --format json`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform validate`\n- Aliases: `zapier validate`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier validate`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Validate your integration.\n\n**Usage**: `zapier-platform validate`\n\nRun the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during `zapier-platform build`, `zapier-platform upload`, `zapier-platform push` or even as a test in `zapier-platform test`.\n\n**Flags**\n* `--without-style` | Forgo pinging the Zapier server to run further checks.\n* `--skip-build` | Skip running the _zapier-build script before validation.\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform validate`\n* `zapier-platform validate --without-style`\n* `zapier-platform validate --skip-build`\n* `zapier-platform validate --format json`\n\n## Examples\n\n```bash\n--without-style\n```\n```bash\n--skip-build\n```\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform validate\n```\n```bash\nzapier-platform validate --without-style\n```\n```bash\nzapier-platform validate --skip-build\n```\n```bash\nzapier-platform validate --format json\n```", "usage": "zapier-platform validate", "signature": "zapier-platform validate", "aliases": ["zapier validate"], "flags": ["`--without-style` | Forgo pinging the Zapier server to run further checks.", "`--skip-build` | Skip running the _zapier-build script before validation.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform validate`", "`zapier-platform validate --without-style`", "`zapier-platform validate --skip-build`", "`zapier-platform validate --format json`"], "args": [], "examples": ["--without-style", "--skip-build", "-d, --debug", "-f, --format", "zapier-platform validate", "zapier-platform validate --without-style", "zapier-platform validate --skip-build", "zapier-platform validate --format json"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "validate"], "related": [], "meta": {"surface": "platform_cli", "internals": "Runs zapier-platform-schema JSON Schema plus optional live style checks against Zapier's servers."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:validate", "kind": "cli_command", "key": "validate", "title": "zapier-platform validate", "summary": "Validate your integration.", "body": "# `validate`\n\n> Validate your integration.\n\n## High-level description\n\nValidate your integration.\n\n## Internals\n\nRuns zapier-platform-schema JSON Schema plus optional live style checks against Zapier's servers.\n\n## Typed inputs\n\n```ts\ntype Input = {\n without_style?: string | boolean; // `--without-style` | Forgo pinging the Zapier server to run further checks.\n skip_build?: string | boolean; // `--skip-build` | Skip running the _zapier-build script before validation.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n zapier_platform validate?: string | boolean; // `zapier-platform validate`\n zapier_platform validate __without_style?: string | boolean; // `zapier-platform validate --without-style`\n zapier_platform validate __skip_build?: string | boolean; // `zapier-platform validate --skip-build`\n zapier_platform validate __format json?: string | boolean; // `zapier-platform validate --format json`\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform validate`\n- Aliases: `zapier validate`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier validate`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> Validate your integration.\n\n**Usage**: `zapier-platform validate`\n\nRun the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during `zapier-platform build`, `zapier-platform upload`, `zapier-platform push` or even as a test in `zapier-platform test`.\n\n**Flags**\n* `--without-style` | Forgo pinging the Zapier server to run further checks.\n* `--skip-build` | Skip running the _zapier-build script before validation.\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n**Examples**\n* `zapier-platform validate`\n* `zapier-platform validate --without-style`\n* `zapier-platform validate --skip-build`\n* `zapier-platform validate --format json`\n\n## Examples\n\n```bash\n--without-style\n```\n```bash\n--skip-build\n```\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```\n```bash\nzapier-platform validate\n```\n```bash\nzapier-platform validate --without-style\n```\n```bash\nzapier-platform validate --skip-build\n```\n```bash\nzapier-platform validate --format json\n```", "usage": "zapier-platform validate", "signature": "zapier-platform validate", "aliases": ["zapier validate"], "flags": ["`--without-style` | Forgo pinging the Zapier server to run further checks.", "`--skip-build` | Skip running the _zapier-build script before validation.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.", "`zapier-platform validate`", "`zapier-platform validate --without-style`", "`zapier-platform validate --skip-build`", "`zapier-platform validate --format json`"], "args": [], "examples": ["--without-style", "--skip-build", "-d, --debug", "-f, --format", "zapier-platform validate", "zapier-platform validate --without-style", "zapier-platform validate --skip-build", "zapier-platform validate --format json"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "validate"], "related": [], "meta": {"surface": "platform_cli", "internals": "Runs zapier-platform-schema JSON Schema plus optional live style checks against Zapier's servers."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_function:versions", "kind": "cli_function", "key": "versions", "title": "zapier-platform versions", "summary": "List the versions of your integration available for use in Zapier automations.", "body": "# `versions`\n\n> List the versions of your integration available for use in Zapier automations.\n\n## High-level description\n\nList the versions of your integration available for use in Zapier automations.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n a, __all?: string | boolean; // `-a, --all` | List all versions, including deprecated versions.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform versions`\n- Aliases: `zapier versions`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier versions`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> List the versions of your integration available for use in Zapier automations.\n\n**Usage**: `zapier-platform versions`\n\n**Flags**\n* `-a, --all` | List all versions, including deprecated versions.\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-a, --all\n```\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform versions", "signature": "zapier-platform versions", "aliases": ["zapier versions"], "flags": ["`-a, --all` | List all versions, including deprecated versions.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-a, --all", "-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "versions"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "cli_command:versions", "kind": "cli_command", "key": "versions", "title": "zapier-platform versions", "summary": "List the versions of your integration available for use in Zapier automations.", "body": "# `versions`\n\n> List the versions of your integration available for use in Zapier automations.\n\n## High-level description\n\nList the versions of your integration available for use in Zapier automations.\n\n## Internals\n\nPlatform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/.\n\n## Typed inputs\n\n```ts\ntype Input = {\n a, __all?: string | boolean; // `-a, --all` | List all versions, including deprecated versions.\n d, __debug?: string | boolean; // `-d, --debug` | Show extra debugging output.\n f, __format?: string | boolean; // `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, s\n};\n```\n\n## Outputs\n\n```ts\n// stdout (human table by default). --format json|raw|table|row|plain\n```\n\n## Surface: zapier-platform CLI (build integrations)\n\n- Usage: `zapier-platform versions`\n- Aliases: `zapier versions`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **deprecated alias:** `zapier versions`\n- **MCP:** `n/a (this builds integrations, MCP consumes them)`\n\n## Official text\n\n> List the versions of your integration available for use in Zapier automations.\n\n**Usage**: `zapier-platform versions`\n\n**Flags**\n* `-a, --all` | List all versions, including deprecated versions.\n* `-d, --debug` | Show extra debugging output.\n* `-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.\n\n## Examples\n\n```bash\n-a, --all\n```\n```bash\n-d, --debug\n```\n```bash\n-f, --format\n```", "usage": "zapier-platform versions", "signature": "zapier-platform versions", "aliases": ["zapier versions"], "flags": ["`-a, --all` | List all versions, including deprecated versions.", "`-d, --debug` | Show extra debugging output.", "`-f, --format` | Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`."], "args": [], "examples": ["-a, --all", "-d, --debug", "-f, --format"], "source_url": "https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md", "source_repo": "zapier/zapier-platform", "source_path": "packages/cli/docs/cli.md", "section": "platform-cli", "tags": ["cli", "function", "zapier-platform-cli", "versions"], "related": [], "meta": {"surface": "platform_cli", "internals": "Platform CLI talks to developer.zapier.com with the deploy key in ~/.zapierrc. Implementation: zapier-platform/packages/cli/src/oclif/commands/."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-profile", "kind": "sdk_function", "key": "get-profile", "title": "zapier-sdk get-profile / zapier.getProfile", "summary": "Get current user's profile information", "body": "# `get-profile`\n\n> Get current user's profile information\n\n## High-level description\n\nGet current user's profile information\n\n## Internals\n\nBrowser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.getProfile`. CLI: `zapier-sdk get-profile [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-profile [options]\n// TS: const { data } = await zapier.getProfile({ ... })\n```\n```ts\ntype Input = {\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Accounts)\n\n- Usage: `zapier-sdk get-profile [options]`\n- TypeScript: `zapier.getProfile(...)`\n\n## Related functions\n\n- `login`\n- `logout`\n- `signup`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getProfile()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-profile [options]\n\nGet current user's profile information\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-profile [options]\n```", "usage": "zapier-sdk get-profile [options]", "signature": "zapier.getProfile()", "aliases": ["getProfile", "zapier.getProfile"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk get-profile [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "accounts"], "related": ["login", "logout", "signup"], "meta": {"surface": "sdk", "category": "Accounts", "typescript": "getProfile", "experimental": false, "mcp_twin": null, "internals": "Browser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.getProfile`. CLI: `zapier-sdk get-profile [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:login", "kind": "sdk_function", "key": "login", "title": "zapier-sdk login / zapier.login", "summary": "Log in to Zapier to access your account", "body": "# `login`\n\n> Log in to Zapier to access your account\n\n## High-level description\n\nLog in to Zapier to access your account\n\n## Internals\n\nBrowser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.login`. CLI: `zapier-sdk login [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk login [options]\n// TS: const { data } = await zapier.login({ ... })\n```\n```ts\ntype Input = {\n name?: string | boolean; // --name <string> Name to identify these credentials (defaults to\n timeout?: string | boolean; // --timeout <string> Login timeout in seconds (default: 300)\n use_approvals?: string | boolean; // --use-approvals Require approvals for actions performed with these\n non_interactive?: string | boolean; // --non-interactive Skip interactive prompts. Uses defaults where\n headless?: string | boolean; // --headless Use when logging in from a machine that has no\n callback_url?: string | boolean; // --callback-url <string> Resume a pending non-interactive login with the\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Accounts)\n\n- Usage: `zapier-sdk login [options]`\n- TypeScript: `zapier.login(...)`\n\n## Related functions\n\n- `get-profile`\n- `logout`\n- `signup`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.login()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk login [options]\n\nLog in to Zapier to access your account\n\nOptions:\n --name <string> Name to identify these credentials (defaults to\n <email>@<hostname>). Provide this to set a custom\n name without the interactive prompt.\n --timeout <string> Login timeout in seconds (default: 300)\n --use-approvals Require approvals for actions performed with these\n credentials\n --non-interactive Skip interactive prompts. Uses defaults where\n possible; errors instead of prompting when input is\n required. Useful in CI, piped output, or\n environments where TTY detection is unreliable.\n --headless Use when logging in from a machine that has no\n browser. Prints a login link to open elsewhere, then\n accepts the pasted loopback callback URL.\n --callback-url <string> Resume a pending non-interactive login with the\n final OAuth callback URL from your browser.\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk login [options]\n```", "usage": "zapier-sdk login [options]", "signature": "zapier.login()", "aliases": ["login", "zapier.login"], "flags": ["--name <string> Name to identify these credentials (defaults to", "--timeout <string> Login timeout in seconds (default: 300)", "--use-approvals Require approvals for actions performed with these", "--non-interactive Skip interactive prompts. Uses defaults where", "--headless Use when logging in from a machine that has no", "--callback-url <string> Resume a pending non-interactive login with the", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk login [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "accounts"], "related": ["get-profile", "logout", "signup"], "meta": {"surface": "sdk", "category": "Accounts", "typescript": "login", "experimental": false, "mcp_twin": null, "internals": "Browser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.login`. CLI: `zapier-sdk login [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:logout", "kind": "sdk_function", "key": "logout", "title": "zapier-sdk logout / zapier.logout", "summary": "Log out of your Zapier account", "body": "# `logout`\n\n> Log out of your Zapier account\n\n## High-level description\n\nLog out of your Zapier account\n\n## Internals\n\nBrowser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.logout`. CLI: `zapier-sdk logout [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk logout [options]\n// TS: const { data } = await zapier.logout({ ... })\n```\n```ts\ntype Input = {\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Accounts)\n\n- Usage: `zapier-sdk logout [options]`\n- TypeScript: `zapier.logout(...)`\n\n## Related functions\n\n- `get-profile`\n- `login`\n- `signup`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.logout()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk logout [options]\n\nLog out of your Zapier account\n\nOptions:\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk logout [options]\n```", "usage": "zapier-sdk logout [options]", "signature": "zapier.logout()", "aliases": ["logout", "zapier.logout"], "flags": ["-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk logout [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "accounts"], "related": ["get-profile", "login", "signup"], "meta": {"surface": "sdk", "category": "Accounts", "typescript": "logout", "experimental": false, "mcp_twin": null, "internals": "Browser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.logout`. CLI: `zapier-sdk logout [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:signup", "kind": "sdk_function", "key": "signup", "title": "zapier-sdk signup / zapier.signup", "summary": "Set up Zapier account access and SDK credentials", "body": "# `signup`\n\n> Set up Zapier account access and SDK credentials\n\n## High-level description\n\nSet up Zapier account access and SDK credentials\n\n## Internals\n\nBrowser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.signup`. CLI: `zapier-sdk signup [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk signup [options]\n// TS: const { data } = await zapier.signup({ ... })\n```\n```ts\ntype Input = {\n timeout?: string | boolean; // --timeout <string> Signup timeout in seconds (default: 300)\n use_approvals?: string | boolean; // --use-approvals Require approvals for actions performed with these\n non_interactive?: string | boolean; // --non-interactive Skip interactive prompts. Uses defaults where\n headless?: string | boolean; // --headless Use when signing up from a machine that has no\n callback_url?: string | boolean; // --callback-url <string> Resume a pending non-interactive signup with the\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Accounts)\n\n- Usage: `zapier-sdk signup [options]`\n- TypeScript: `zapier.signup(...)`\n\n## Related functions\n\n- `get-profile`\n- `login`\n- `logout`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.signup()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk signup [options]\n\nSet up Zapier account access and SDK credentials\n\nOptions:\n --timeout <string> Signup timeout in seconds (default: 300)\n --use-approvals Require approvals for actions performed with these\n credentials\n --non-interactive Skip interactive prompts. Uses defaults where\n possible; errors instead of prompting when input is\n required. Useful in CI, piped output, or\n environments where TTY detection is unreliable.\n --headless Use when signing up from a machine that has no\n browser. Prints a signup link to open elsewhere,\n then accepts the pasted loopback callback URL.\n --callback-url <string> Resume a pending non-interactive signup with the\n final OAuth callback URL from your browser.\n -h, --help Display help for command\n```\n\n### Apps\n\n## Examples\n\n```bash\nzapier-sdk signup [options]\n```", "usage": "zapier-sdk signup [options]", "signature": "zapier.signup()", "aliases": ["signup", "zapier.signup"], "flags": ["--timeout <string> Signup timeout in seconds (default: 300)", "--use-approvals Require approvals for actions performed with these", "--non-interactive Skip interactive prompts. Uses defaults where", "--headless Use when signing up from a machine that has no", "--callback-url <string> Resume a pending non-interactive signup with the", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk signup [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "accounts"], "related": ["get-profile", "login", "logout"], "meta": {"surface": "sdk", "category": "Accounts", "typescript": "signup", "experimental": false, "mcp_twin": null, "internals": "Browser OAuth to Zapier itself (not a third-party app). Writes SDK credentials used by createZapierSdk(). TypeScript method: `zapier.signup`. CLI: `zapier-sdk signup [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-app", "kind": "sdk_function", "key": "get-app", "title": "zapier-sdk get-app / zapier.getApp", "summary": "Get detailed information about a specific app", "body": "# `get-app`\n\n> Get detailed information about a specific app\n\n## High-level description\n\nGet detailed information about a specific app\n\n## Internals\n\nDirectory of 9,000+ integrations. Same catalog as MCP discover_zapier_actions. TypeScript method: `zapier.getApp`. CLI: `zapier-sdk get-app [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-app [options] [app]\n// TS: const { data } = await zapier.getApp({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Apps)\n\n- Usage: `zapier-sdk get-app [options] [app]`\n- TypeScript: `zapier.getApp(...)`\n\n## Related functions\n\n- `list-apps`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getApp()`\n- **MCP:** `discover_zapier_actions`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-app [options] [app]\n\nGet detailed information about a specific app\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-app [options] [app]\n```", "usage": "zapier-sdk get-app [options] [app]", "signature": "zapier.getApp()", "aliases": ["getApp", "zapier.getApp"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,"], "examples": ["zapier-sdk get-app [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "apps"], "related": ["list-apps"], "meta": {"surface": "sdk", "category": "Apps", "typescript": "getApp", "experimental": false, "mcp_twin": "discover_zapier_actions", "internals": "Directory of 9,000+ integrations. Same catalog as MCP discover_zapier_actions. TypeScript method: `zapier.getApp`. CLI: `zapier-sdk get-app [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-apps", "kind": "sdk_function", "key": "list-apps", "title": "zapier-sdk list-apps / zapier.listApps", "summary": "List all available apps with optional filtering", "body": "# `list-apps`\n\n> List all available apps with optional filtering\n\n## High-level description\n\nList all available apps with optional filtering\n\n## Internals\n\nDirectory of 9,000+ integrations. Same catalog as MCP discover_zapier_actions. TypeScript method: `zapier.listApps`. CLI: `zapier-sdk list-apps [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-apps [options]\n// TS: const { data } = await zapier.listApps({ ... })\n```\n```ts\ntype Input = {\n search?: string | boolean; // --search <string> Search term to filter apps by name\n page_size?: string | boolean; // --page-size <number> Number of apps per page\n apps?: string | boolean; // --apps <value> Filter apps by app keys (e.g., 'SlackCLIAPI' or slug\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Apps)\n\n- Usage: `zapier-sdk list-apps [options]`\n- TypeScript: `zapier.listApps(...)`\n\n## Related functions\n\n- `get-app`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listApps()`\n- **MCP:** `discover_zapier_actions`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-apps [options]\n\nList all available apps with optional filtering\n\nOptions:\n --search <string> Search term to filter apps by name\n --page-size <number> Number of apps per page\n --apps <value> Filter apps by app keys (e.g., 'SlackCLIAPI' or slug\n like 'github') (default: [])\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n### Connections\n\n## Examples\n\n```bash\nzapier-sdk list-apps [options]\n```", "usage": "zapier-sdk list-apps [options]", "signature": "zapier.listApps()", "aliases": ["listApps", "zapier.listApps"], "flags": ["--search <string> Search term to filter apps by name", "--page-size <number> Number of apps per page", "--apps <value> Filter apps by app keys (e.g., 'SlackCLIAPI' or slug", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk list-apps [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "apps"], "related": ["get-app"], "meta": {"surface": "sdk", "category": "Apps", "typescript": "listApps", "experimental": false, "mcp_twin": "discover_zapier_actions", "internals": "Directory of 9,000+ integrations. Same catalog as MCP discover_zapier_actions. TypeScript method: `zapier.listApps`. CLI: `zapier-sdk list-apps [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:create-connection", "kind": "sdk_function", "key": "create-connection", "title": "zapier-sdk create-connection / zapier.createConnection", "summary": "Create a new app connection, end-to-end. Mints the start URL via", "body": "# `create-connection`\n\n> Create a new app connection, end-to-end. Mints the start URL via\n\n## High-level description\n\nCreate a new app connection, end-to-end. Mints the start URL via\n\n## Internals\n\nOAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.createConnection`. CLI: `zapier-sdk create-connection [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk create-connection [options] [app]\n// TS: const { data } = await zapier.createConnection({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name\n auto?: string | boolean; // --browser <string> When to auto-open the URL in a browser. `auto`\n timeout_ms?: string | boolean; // --timeout-ms <number> How long to wait for the user to complete the\n poll_interval_ms?: string | boolean; // --poll-interval-ms <number> Delay before the first poll request, in ms.\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Connections)\n\n- Usage: `zapier-sdk create-connection [options] [app]`\n- TypeScript: `zapier.createConnection(...)`\n\n## Related functions\n\n- `find-first-connection`\n- `find-unique-connection`\n- `get-connection`\n- `get-connection-start-url`\n- `list-connections`\n- `wait-for-new-connection`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.createConnection()`\n- **MCP:** `manage_zapier_connections`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk create-connection [options] [app]\n\nCreate a new app connection, end-to-end. Mints the start URL via\n`get-connection-start-url`, prints it to stderr, opportunistically opens it in\na browser when it looks safe to do so (skipping CI / SSH / headless-Linux by\ndefault — pass `--browser always` to force, `--browser never` to suppress),\nthen polls via `wait-for-new-connection` until the user completes OAuth and the\nnew connection appears. Returns the connection.\n\nThis is the right command for most callers. Reach for the lower-level building\nblocks when you want either of: (a) hand off the URL and *not* block on\ncompletion — call `get-connection-start-url` alone, no\n`wait-for-new-connection` needed, or (b) do something custom between minting\nthe URL and waiting — call `get-connection-start-url`, do your work (email or\nDM the URL, render a QR code, etc.), then `wait-for-new-connection`.\n\nArguments:\n app App slug (e.g., 'github'), implementation name\n (e.g., 'SlackCLIAPI'), or versioned ID (e.g.,\n 'github@1.2.3')\n\nOptions:\n --browser <string> When to auto-open the URL in a browser. `auto`\n (default) opens in local sessions and skips\n opening in CI / SSH / headless-Linux. `always`\n forces the open attempt. `never` skips it. The\n URL is always printed to stderr regardless — a\n failed or skipped open degrades gracefully to\n copy-paste. (default: \"auto\")\n --timeout-ms <number> How long to wait for the user to complete the\n connection flow before giving up. Default 5\n minutes (300_000).\n --poll-interval-ms <number> Delay before the first poll request, in ms.\n Default 3 seconds (3_000). Subsequent polling\n cadence is managed by the SDK's polling\n primitive (backoff with sane defaults).\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk create-connection [options] [app]\n```", "usage": "zapier-sdk create-connection [options] [app]", "signature": "zapier.createConnection()", "aliases": ["createConnection", "zapier.createConnection"], "flags": ["--browser <string> When to auto-open the URL in a browser. `auto`", "--timeout-ms <number> How long to wait for the user to complete the", "--poll-interval-ms <number> Delay before the first poll request, in ms.", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name"], "examples": ["zapier-sdk create-connection [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "connections"], "related": ["find-first-connection", "find-unique-connection", "get-connection", "get-connection-start-url", "list-connections", "wait-for-new-connection"], "meta": {"surface": "sdk", "category": "Connections", "typescript": "createConnection", "experimental": false, "mcp_twin": "manage_zapier_connections", "internals": "OAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.createConnection`. CLI: `zapier-sdk create-connection [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:find-first-connection", "kind": "sdk_function", "key": "find-first-connection", "title": "zapier-sdk find-first-connection / zapier.findFirstConnection", "summary": "Find the first connection matching the criteria", "body": "# `find-first-connection`\n\n> Find the first connection matching the criteria\n\n## High-level description\n\nFind the first connection matching the criteria\n\n## Internals\n\nOAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.findFirstConnection`. CLI: `zapier-sdk find-first-connection [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk find-first-connection [options] [app]\n// TS: const { data } = await zapier.findFirstConnection({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App key of connections to list (e.g., 'SlackCLIAPI' or\n search?: string | boolean; // --search <string> Search term to filter connections by title\n title?: string | boolean; // --title <string> Filter connections by exact title match (searches first,\n owner?: string | boolean; // --owner <string> Filter by owner, 'me' for your own connections or a\n account?: string | boolean; // --account <string> Account to filter by\n include_shared?: string | boolean; // --include-shared Include connections shared with you. By default, only\n expired?: string | boolean; // --expired Show only expired connections (default: only non-expired\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Connections)\n\n- Usage: `zapier-sdk find-first-connection [options] [app]`\n- TypeScript: `zapier.findFirstConnection(...)`\n\n## Related functions\n\n- `create-connection`\n- `find-unique-connection`\n- `get-connection`\n- `get-connection-start-url`\n- `list-connections`\n- `wait-for-new-connection`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.findFirstConnection()`\n- **MCP:** `list_zapier_connections`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk find-first-connection [options] [app]\n\nFind the first connection matching the criteria\n\nArguments:\n app App key of connections to list (e.g., 'SlackCLIAPI' or\n slug like 'github')\n\nOptions:\n --search <string> Search term to filter connections by title\n --title <string> Filter connections by exact title match (searches first,\n then filters locally)\n --owner <string> Filter by owner, 'me' for your own connections or a\n specific user ID\n --account <string> Account to filter by\n --include-shared Include connections shared with you. By default, only\n your own connections are returned (owner=me). Set to true\n to also include shared connections.\n --expired Show only expired connections (default: only non-expired\n connections are returned)\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk find-first-connection [options] [app]\n```", "usage": "zapier-sdk find-first-connection [options] [app]", "signature": "zapier.findFirstConnection()", "aliases": ["findFirstConnection", "zapier.findFirstConnection"], "flags": ["--search <string> Search term to filter connections by title", "--title <string> Filter connections by exact title match (searches first,", "--owner <string> Filter by owner, 'me' for your own connections or a", "--account <string> Account to filter by", "--include-shared Include connections shared with you. By default, only", "--expired Show only expired connections (default: only non-expired", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App key of connections to list (e.g., 'SlackCLIAPI' or"], "examples": ["zapier-sdk find-first-connection [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "connections"], "related": ["create-connection", "find-unique-connection", "get-connection", "get-connection-start-url", "list-connections", "wait-for-new-connection"], "meta": {"surface": "sdk", "category": "Connections", "typescript": "findFirstConnection", "experimental": false, "mcp_twin": "list_zapier_connections", "internals": "OAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.findFirstConnection`. CLI: `zapier-sdk find-first-connection [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:find-unique-connection", "kind": "sdk_function", "key": "find-unique-connection", "title": "zapier-sdk find-unique-connection / zapier.findUniqueConnection", "summary": "Find a unique connection matching the criteria", "body": "# `find-unique-connection`\n\n> Find a unique connection matching the criteria\n\n## High-level description\n\nFind a unique connection matching the criteria\n\n## Internals\n\nOAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.findUniqueConnection`. CLI: `zapier-sdk find-unique-connection [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk find-unique-connection [options] [app]\n// TS: const { data } = await zapier.findUniqueConnection({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App key of connections to list (e.g., 'SlackCLIAPI' or\n search?: string | boolean; // --search <string> Search term to filter connections by title\n title?: string | boolean; // --title <string> Filter connections by exact title match (searches first,\n owner?: string | boolean; // --owner <string> Filter by owner, 'me' for your own connections or a\n account?: string | boolean; // --account <string> Account to filter by\n include_shared?: string | boolean; // --include-shared Include connections shared with you. By default, only\n expired?: string | boolean; // --expired Show only expired connections (default: only non-expired\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Connections)\n\n- Usage: `zapier-sdk find-unique-connection [options] [app]`\n- TypeScript: `zapier.findUniqueConnection(...)`\n\n## Related functions\n\n- `create-connection`\n- `find-first-connection`\n- `get-connection`\n- `get-connection-start-url`\n- `list-connections`\n- `wait-for-new-connection`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.findUniqueConnection()`\n- **MCP:** `list_zapier_connections`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk find-unique-connection [options] [app]\n\nFind a unique connection matching the criteria\n\nArguments:\n app App key of connections to list (e.g., 'SlackCLIAPI' or\n slug like 'github')\n\nOptions:\n --search <string> Search term to filter connections by title\n --title <string> Filter connections by exact title match (searches first,\n then filters locally)\n --owner <string> Filter by owner, 'me' for your own connections or a\n specific user ID\n --account <string> Account to filter by\n --include-shared Include connections shared with you. By default, only\n your own connections are returned (owner=me). Set to true\n to also include shared connections.\n --expired Show only expired connections (default: only non-expired\n connections are returned)\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk find-unique-connection [options] [app]\n```", "usage": "zapier-sdk find-unique-connection [options] [app]", "signature": "zapier.findUniqueConnection()", "aliases": ["findUniqueConnection", "zapier.findUniqueConnection"], "flags": ["--search <string> Search term to filter connections by title", "--title <string> Filter connections by exact title match (searches first,", "--owner <string> Filter by owner, 'me' for your own connections or a", "--account <string> Account to filter by", "--include-shared Include connections shared with you. By default, only", "--expired Show only expired connections (default: only non-expired", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App key of connections to list (e.g., 'SlackCLIAPI' or"], "examples": ["zapier-sdk find-unique-connection [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "connections"], "related": ["create-connection", "find-first-connection", "get-connection", "get-connection-start-url", "list-connections", "wait-for-new-connection"], "meta": {"surface": "sdk", "category": "Connections", "typescript": "findUniqueConnection", "experimental": false, "mcp_twin": "list_zapier_connections", "internals": "OAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.findUniqueConnection`. CLI: `zapier-sdk find-unique-connection [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-connection", "kind": "sdk_function", "key": "get-connection", "title": "zapier-sdk get-connection / zapier.getConnection", "summary": "Get details for a specific connection", "body": "# `get-connection`\n\n> Get details for a specific connection\n\n## High-level description\n\nGet details for a specific connection\n\n## Internals\n\nOAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.getConnection`. CLI: `zapier-sdk get-connection [options] [connection]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-connection [options] [connection]\n// TS: const { data } = await zapier.getConnection({ ... })\n```\n```ts\ntype Input = {\n connection?: string; // connection Connection alias or connection ID (UUID or positive integer).\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Connections)\n\n- Usage: `zapier-sdk get-connection [options] [connection]`\n- TypeScript: `zapier.getConnection(...)`\n\n## Related functions\n\n- `create-connection`\n- `find-first-connection`\n- `find-unique-connection`\n- `get-connection-start-url`\n- `list-connections`\n- `wait-for-new-connection`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getConnection()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-connection [options] [connection]\n\nGet details for a specific connection\n\nArguments:\n connection Connection alias or connection ID (UUID or positive integer).\n Strings that match a key in the connections map are resolved\n against it; otherwise the value is used as a connection ID\n directly.\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-connection [options] [connection]\n```", "usage": "zapier-sdk get-connection [options] [connection]", "signature": "zapier.getConnection()", "aliases": ["getConnection", "zapier.getConnection"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["connection Connection alias or connection ID (UUID or positive integer)."], "examples": ["zapier-sdk get-connection [options] [connection]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "connections"], "related": ["create-connection", "find-first-connection", "find-unique-connection", "get-connection-start-url", "list-connections", "wait-for-new-connection"], "meta": {"surface": "sdk", "category": "Connections", "typescript": "getConnection", "experimental": false, "mcp_twin": null, "internals": "OAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.getConnection`. CLI: `zapier-sdk get-connection [options] [connection]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-connection-start-url", "kind": "sdk_function", "key": "get-connection-start-url", "title": "zapier-sdk get-connection-start-url / zapier.getConnectionStartUrl", "summary": "Mint a short-lived URL that begins an SDK-initiated connection flow. The URL is", "body": "# `get-connection-start-url`\n\n> Mint a short-lived URL that begins an SDK-initiated connection flow. The URL is\n\n## High-level description\n\nMint a short-lived URL that begins an SDK-initiated connection flow. The URL is\n\n## Internals\n\nOAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.getConnectionStartUrl`. CLI: `zapier-sdk get-connection-start-url [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-connection-start-url [options] [app]\n// TS: const { data } = await zapier.getConnectionStartUrl({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Connections)\n\n- Usage: `zapier-sdk get-connection-start-url [options] [app]`\n- TypeScript: `zapier.getConnectionStartUrl(...)`\n\n## Related functions\n\n- `create-connection`\n- `find-first-connection`\n- `find-unique-connection`\n- `get-connection`\n- `list-connections`\n- `wait-for-new-connection`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getConnectionStartUrl()`\n- **MCP:** `manage_zapier_connections`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-connection-start-url [options] [app]\n\nMint a short-lived URL that begins an SDK-initiated connection flow. The URL is\nsigned by zapier.com and bound to the current user/account — opening it in a\ndifferent browser session will fail the binding check. Returns the URL as data\nso the caller decides what to do with it.\n\nUse this directly (rather than the higher-level `create-connection`) when you\nwant either of: (a) hand off the URL and *not* block waiting for completion —\ncall this alone, skip `wait-for-new-connection` entirely, or (b) do something\ncustom between minting the URL and waiting for the connection — call this, then\nemail or DM the URL, render it as a QR code for mobile sign-in, etc., then call\n`wait-for-new-connection`. For the common case where you'd just print and poll\nback-to-back, `create-connection` is one call.\n\nPair with `wait-for-new-connection` to detect completion: pass the `startedAt`\nreturned here straight through (it's the server's mint time, so polling isn't\naffected by client clock skew). Example (JS):\n\n```ts\nconst { data: { url, app, startedAt } } = await zapier.getConnectionStartUrl({\napp: 'slack' });\n// hand `url` off — print it, DM it, email it, render a button, whatever\nconst { data: conn } = await zapier.waitForNewConnection({ app, startedAt });\n```\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-connection-start-url [options] [app]\n```", "usage": "zapier-sdk get-connection-start-url [options] [app]", "signature": "zapier.getConnectionStartUrl()", "aliases": ["getConnectionStartUrl", "zapier.getConnectionStartUrl"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,"], "examples": ["zapier-sdk get-connection-start-url [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "connections"], "related": ["create-connection", "find-first-connection", "find-unique-connection", "get-connection", "list-connections", "wait-for-new-connection"], "meta": {"surface": "sdk", "category": "Connections", "typescript": "getConnectionStartUrl", "experimental": false, "mcp_twin": "manage_zapier_connections", "internals": "OAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.getConnectionStartUrl`. CLI: `zapier-sdk get-connection-start-url [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-connections", "kind": "sdk_function", "key": "list-connections", "title": "zapier-sdk list-connections / zapier.listConnections", "summary": "List available connections with optional filtering", "body": "# `list-connections`\n\n> List available connections with optional filtering\n\n## High-level description\n\nList available connections with optional filtering\n\n## Internals\n\nOAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.listConnections`. CLI: `zapier-sdk list-connections [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-connections [options] [app]\n// TS: const { data } = await zapier.listConnections({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App key of connections to list (e.g., 'SlackCLIAPI' or\n search?: string | boolean; // --search <string> Search term to filter connections by title\n title?: string | boolean; // --title <string> Filter connections by exact title match (searches\n owner?: string | boolean; // --owner <string> Filter by owner, 'me' for your own connections or a\n connections?: string | boolean; // --connections <value> List of connection IDs to filter by (default: [])\n account?: string | boolean; // --account <string> Account to filter by\n include_shared?: string | boolean; // --include-shared Include connections shared with you. By default, only\n expired?: string | boolean; // --expired Show only expired connections (default: only\n page_size?: string | boolean; // --page-size <number> Number of connections per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Connections)\n\n- Usage: `zapier-sdk list-connections [options] [app]`\n- TypeScript: `zapier.listConnections(...)`\n\n## Related functions\n\n- `create-connection`\n- `find-first-connection`\n- `find-unique-connection`\n- `get-connection`\n- `get-connection-start-url`\n- `wait-for-new-connection`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listConnections()`\n- **MCP:** `list_zapier_connections`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-connections [options] [app]\n\nList available connections with optional filtering\n\nArguments:\n app App key of connections to list (e.g., 'SlackCLIAPI' or\n slug like 'github')\n\nOptions:\n --search <string> Search term to filter connections by title\n --title <string> Filter connections by exact title match (searches\n first, then filters locally)\n --owner <string> Filter by owner, 'me' for your own connections or a\n specific user ID\n --connections <value> List of connection IDs to filter by (default: [])\n --account <string> Account to filter by\n --include-shared Include connections shared with you. By default, only\n your own connections are returned (owner=me). Set to\n true to also include shared connections.\n --expired Show only expired connections (default: only\n non-expired connections are returned)\n --page-size <number> Number of connections per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-connections [options] [app]\n```", "usage": "zapier-sdk list-connections [options] [app]", "signature": "zapier.listConnections()", "aliases": ["listConnections", "zapier.listConnections"], "flags": ["--search <string> Search term to filter connections by title", "--title <string> Filter connections by exact title match (searches", "--owner <string> Filter by owner, 'me' for your own connections or a", "--connections <value> List of connection IDs to filter by (default: [])", "--account <string> Account to filter by", "--include-shared Include connections shared with you. By default, only", "--expired Show only expired connections (default: only", "--page-size <number> Number of connections per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App key of connections to list (e.g., 'SlackCLIAPI' or"], "examples": ["zapier-sdk list-connections [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "connections"], "related": ["create-connection", "find-first-connection", "find-unique-connection", "get-connection", "get-connection-start-url", "wait-for-new-connection"], "meta": {"surface": "sdk", "category": "Connections", "typescript": "listConnections", "experimental": false, "mcp_twin": "list_zapier_connections", "internals": "OAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.listConnections`. CLI: `zapier-sdk list-connections [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:wait-for-new-connection", "kind": "sdk_function", "key": "wait-for-new-connection", "title": "zapier-sdk wait-for-new-connection / zapier.waitForNewConnection", "summary": "Wait for a new connection to appear for the given app. Polls", "body": "# `wait-for-new-connection`\n\n> Wait for a new connection to appear for the given app. Polls\n\n## High-level description\n\nWait for a new connection to appear for the given app. Polls\n\n## Internals\n\nOAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.waitForNewConnection`. CLI: `zapier-sdk wait-for-new-connection [options] [app] [started-at]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk wait-for-new-connection [options] [app] [started-at]\n// TS: const { data } = await zapier.waitForNewConnection({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name\n started-at?: string; // started-at Unix timestamp (seconds). Only connections whose\n timeout_ms?: string | boolean; // --timeout-ms <number> How long to wait before giving up. Default 5\n poll_interval_ms?: string | boolean; // --poll-interval-ms <number> Delay before the first poll request, in ms.\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Connections)\n\n- Usage: `zapier-sdk wait-for-new-connection [options] [app] [started-at]`\n- TypeScript: `zapier.waitForNewConnection(...)`\n\n## Related functions\n\n- `create-connection`\n- `find-first-connection`\n- `find-unique-connection`\n- `get-connection`\n- `get-connection-start-url`\n- `list-connections`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.waitForNewConnection()`\n- **MCP:** `manage_zapier_connections (after auth_url)`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk wait-for-new-connection [options] [app] [started-at]\n\nWait for a new connection to appear for the given app. Polls\n`/api/v0/connections` with server-side `ordering=-date` until the most recent\nmatching row's `date` is at or after the started-at timestamp, then returns it.\nPair with `get-connection-start-url` — that mints the URL the user opens, this\nwaits for the resulting connection to land. Errors with a timeout after the\nconfigured timeout (default 5 min). Example (JS):\n\n```ts\nconst { data: { url, app, startedAt } } = await zapier.getConnectionStartUrl({\napp: 'slack' });\n// show `url` to the user via the channel they're reading from\nconst { data: conn } = await zapier.waitForNewConnection({ app, startedAt });\n```\n\nArguments:\n app App slug (e.g., 'github'), implementation name\n (e.g., 'SlackCLIAPI'), or versioned ID (e.g.,\n 'github@1.2.3')\n started-at Unix timestamp (seconds). Only connections whose\n `date` is at or after this value count as 'new'.\n Prefer the `startedAt` returned by\n `get-connection-start-url` — it's\n server-stamped, so the comparison isn't thrown\n off by client clock skew. If you mint the\n timestamp yourself, capture it *before* showing\n the start URL so a fast OAuth completion isn't\n missed.\n\nOptions:\n --timeout-ms <number> How long to wait before giving up. Default 5\n minutes (300_000).\n --poll-interval-ms <number> Delay before the first poll request, in ms.\n Default 3 seconds (3_000). Subsequent polling\n cadence is managed by the SDK's polling\n primitive (backoff with sane defaults).\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n### Actions\n\n## Examples\n\n```bash\nzapier-sdk wait-for-new-connection [options] [app] [started-at]\n```", "usage": "zapier-sdk wait-for-new-connection [options] [app] [started-at]", "signature": "zapier.waitForNewConnection()", "aliases": ["waitForNewConnection", "zapier.waitForNewConnection"], "flags": ["--timeout-ms <number> How long to wait before giving up. Default 5", "--poll-interval-ms <number> Delay before the first poll request, in ms.", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name", "started-at Unix timestamp (seconds). Only connections whose"], "examples": ["zapier-sdk wait-for-new-connection [options] [app] [started-at]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "connections"], "related": ["create-connection", "find-first-connection", "find-unique-connection", "get-connection", "get-connection-start-url", "list-connections"], "meta": {"surface": "sdk", "category": "Connections", "typescript": "waitForNewConnection", "experimental": false, "mcp_twin": "manage_zapier_connections (after auth_url)", "internals": "OAuth grants Zapier holds per app+user. MCP twins: list/manage_zapier_connections. TypeScript method: `zapier.waitForNewConnection`. CLI: `zapier-sdk wait-for-new-connection [options] [app] [started-at]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-action", "kind": "sdk_function", "key": "get-action", "title": "zapier-sdk get-action / zapier.getAction", "summary": "Get detailed information about a specific action", "body": "# `get-action`\n\n> Get detailed information about a specific action\n\n## High-level description\n\nGet detailed information about a specific action\n\n## Internals\n\nDiscover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.getAction`. CLI: `zapier-sdk get-action [options] [app] [action-type] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-action [options] [app] [action-type] [action]\n// TS: const { data } = await zapier.getAction({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n action-type?: string; // action-type Action type that matches the action's defined type\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Actions)\n\n- Usage: `zapier-sdk get-action [options] [app] [action-type] [action]`\n- TypeScript: `zapier.getAction(...)`\n\n## Related functions\n\n- `get-action-input-fields-schema`\n- `list-action-input-field-choices`\n- `list-action-input-fields`\n- `list-actions`\n- `run-action`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getAction()`\n- **MCP:** `inspect_zapier_actions`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-action [options] [app] [action-type] [action]\n\nGet detailed information about a specific action\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n action-type Action type that matches the action's defined type\n action Action key (e.g., 'send_message' or 'find_row')\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-action [options] [app] [action-type] [action]\n```", "usage": "zapier-sdk get-action [options] [app] [action-type] [action]", "signature": "zapier.getAction()", "aliases": ["getAction", "zapier.getAction"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,", "action-type Action type that matches the action's defined type", "action Action key (e.g., 'send_message' or 'find_row')"], "examples": ["zapier-sdk get-action [options] [app] [action-type] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "actions"], "related": ["get-action-input-fields-schema", "list-action-input-field-choices", "list-action-input-fields", "list-actions", "run-action"], "meta": {"surface": "sdk", "category": "Actions", "typescript": "getAction", "experimental": false, "mcp_twin": "inspect_zapier_actions", "internals": "Discover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.getAction`. CLI: `zapier-sdk get-action [options] [app] [action-type] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-action-input-fields-schema", "kind": "sdk_function", "key": "get-action-input-fields-schema", "title": "zapier-sdk get-action-input-fields-schema / zapier.getActionInputFieldsSchema", "summary": "Get the JSON Schema representation of input fields for an action. Returns a", "body": "# `get-action-input-fields-schema`\n\n> Get the JSON Schema representation of input fields for an action. Returns a\n\n## High-level description\n\nGet the JSON Schema representation of input fields for an action. Returns a\n\n## Internals\n\nDiscover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.getActionInputFieldsSchema`. CLI: `zapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]\n// TS: const { data } = await zapier.getActionInputFieldsSchema({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App key (e.g., 'SlackCLIAPI' or slug like 'github') to\n action-type?: string; // action-type Action type that matches the action's defined type\n action?: string; // action Action key to get the input schema for\n connection?: string | boolean; // --connection <string> Connection alias or connection ID (UUID or positive\n inputs?: string | boolean; // --inputs <object> Current input values that may affect the schema (e.g.,\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Actions)\n\n- Usage: `zapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]`\n- TypeScript: `zapier.getActionInputFieldsSchema(...)`\n\n## Related functions\n\n- `get-action`\n- `list-action-input-field-choices`\n- `list-action-input-fields`\n- `list-actions`\n- `run-action`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getActionInputFieldsSchema()`\n- **MCP:** `inspect_zapier_actions`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]\n\nGet the JSON Schema representation of input fields for an action. Returns a\nJSON Schema object describing the structure, types, and validation rules for\nthe action's input parameters.\n\nArguments:\n app App key (e.g., 'SlackCLIAPI' or slug like 'github') to\n get the input schema for\n action-type Action type that matches the action's defined type\n action Action key to get the input schema for\n\nOptions:\n --connection <string> Connection alias or connection ID (UUID or positive\n integer). Strings that match a key in the connections\n map are resolved against it; otherwise the value is\n used as a connection ID directly. Mutually exclusive\n with connectionId.\n --inputs <object> Current input values that may affect the schema (e.g.,\n when fields depend on other field values)\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]\n```", "usage": "zapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]", "signature": "zapier.getActionInputFieldsSchema()", "aliases": ["getActionInputFieldsSchema", "zapier.getActionInputFieldsSchema"], "flags": ["--connection <string> Connection alias or connection ID (UUID or positive", "--inputs <object> Current input values that may affect the schema (e.g.,", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App key (e.g., 'SlackCLIAPI' or slug like 'github') to", "action-type Action type that matches the action's defined type", "action Action key to get the input schema for"], "examples": ["zapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "actions"], "related": ["get-action", "list-action-input-field-choices", "list-action-input-fields", "list-actions", "run-action"], "meta": {"surface": "sdk", "category": "Actions", "typescript": "getActionInputFieldsSchema", "experimental": false, "mcp_twin": "inspect_zapier_actions", "internals": "Discover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.getActionInputFieldsSchema`. CLI: `zapier-sdk get-action-input-fields-schema [options] [app] [action-type] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-action-input-field-choices", "kind": "sdk_function", "key": "list-action-input-field-choices", "title": "zapier-sdk list-action-input-field-choices / zapier.listActionInputFieldChoices", "summary": "Get the available choices for a dynamic dropdown input field", "body": "# `list-action-input-field-choices`\n\n> Get the available choices for a dynamic dropdown input field\n\n## High-level description\n\nGet the available choices for a dynamic dropdown input field\n\n## Internals\n\nDiscover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.listActionInputFieldChoices`. CLI: `zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]\n// TS: const { data } = await zapier.listActionInputFieldChoices({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n action-type?: string; // action-type Action type that matches the action's defined type\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n input-field?: string; // input-field Input field key to get choices for\n connection?: string | boolean; // --connection <string> Connection alias or connection ID (UUID or positive\n inputs?: string | boolean; // --inputs <object> Current input values that may affect available choices\n page?: string | boolean; // --page <number> Page number for paginated results\n page_size?: string | boolean; // --page-size <number> Number of choices per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Actions)\n\n- Usage: `zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]`\n- TypeScript: `zapier.listActionInputFieldChoices(...)`\n\n## Related functions\n\n- `get-action`\n- `get-action-input-fields-schema`\n- `list-action-input-fields`\n- `list-actions`\n- `run-action`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listActionInputFieldChoices()`\n- **MCP:** `inspect_zapier_actions (enum_property)`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]\n\nGet the available choices for a dynamic dropdown input field\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n action-type Action type that matches the action's defined type\n action Action key (e.g., 'send_message' or 'find_row')\n input-field Input field key to get choices for\n\nOptions:\n --connection <string> Connection alias or connection ID (UUID or positive\n integer). Strings that match a key in the connections\n map are resolved against it; otherwise the value is\n used as a connection ID directly. Mutually exclusive\n with connectionId.\n --inputs <object> Current input values that may affect available choices\n --page <number> Page number for paginated results\n --page-size <number> Number of choices per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]\n```", "usage": "zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]", "signature": "zapier.listActionInputFieldChoices()", "aliases": ["listActionInputFieldChoices", "zapier.listActionInputFieldChoices"], "flags": ["--connection <string> Connection alias or connection ID (UUID or positive", "--inputs <object> Current input values that may affect available choices", "--page <number> Page number for paginated results", "--page-size <number> Number of choices per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,", "action-type Action type that matches the action's defined type", "action Action key (e.g., 'send_message' or 'find_row')", "input-field Input field key to get choices for"], "examples": ["zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "actions"], "related": ["get-action", "get-action-input-fields-schema", "list-action-input-fields", "list-actions", "run-action"], "meta": {"surface": "sdk", "category": "Actions", "typescript": "listActionInputFieldChoices", "experimental": false, "mcp_twin": "inspect_zapier_actions (enum_property)", "internals": "Discover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.listActionInputFieldChoices`. CLI: `zapier-sdk list-action-input-field-choices [options] [app] [action-type] [action] [input-field]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-action-input-fields", "kind": "sdk_function", "key": "list-action-input-fields", "title": "zapier-sdk list-action-input-fields / zapier.listActionInputFields", "summary": "Get the input fields required for a specific action", "body": "# `list-action-input-fields`\n\n> Get the input fields required for a specific action\n\n## High-level description\n\nGet the input fields required for a specific action\n\n## Internals\n\nDiscover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.listActionInputFields`. CLI: `zapier-sdk list-action-input-fields [options] [app] [action-type] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-action-input-fields [options] [app] [action-type] [action]\n// TS: const { data } = await zapier.listActionInputFields({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n action-type?: string; // action-type Action type that matches the action's defined type\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n connection?: string | boolean; // --connection <string> Connection alias or connection ID (UUID or positive\n inputs?: string | boolean; // --inputs <object> Current input values that may affect available fields\n page_size?: string | boolean; // --page-size <number> Number of input fields per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Actions)\n\n- Usage: `zapier-sdk list-action-input-fields [options] [app] [action-type] [action]`\n- TypeScript: `zapier.listActionInputFields(...)`\n\n## Related functions\n\n- `get-action`\n- `get-action-input-fields-schema`\n- `list-action-input-field-choices`\n- `list-actions`\n- `run-action`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listActionInputFields()`\n- **MCP:** `inspect_zapier_actions`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-action-input-fields [options] [app] [action-type] [action]\n\nGet the input fields required for a specific action\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n action-type Action type that matches the action's defined type\n action Action key (e.g., 'send_message' or 'find_row')\n\nOptions:\n --connection <string> Connection alias or connection ID (UUID or positive\n integer). Strings that match a key in the connections\n map are resolved against it; otherwise the value is\n used as a connection ID directly. Mutually exclusive\n with connectionId.\n --inputs <object> Current input values that may affect available fields\n --page-size <number> Number of input fields per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-action-input-fields [options] [app] [action-type] [action]\n```", "usage": "zapier-sdk list-action-input-fields [options] [app] [action-type] [action]", "signature": "zapier.listActionInputFields()", "aliases": ["listActionInputFields", "zapier.listActionInputFields"], "flags": ["--connection <string> Connection alias or connection ID (UUID or positive", "--inputs <object> Current input values that may affect available fields", "--page-size <number> Number of input fields per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,", "action-type Action type that matches the action's defined type", "action Action key (e.g., 'send_message' or 'find_row')"], "examples": ["zapier-sdk list-action-input-fields [options] [app] [action-type] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "actions"], "related": ["get-action", "get-action-input-fields-schema", "list-action-input-field-choices", "list-actions", "run-action"], "meta": {"surface": "sdk", "category": "Actions", "typescript": "listActionInputFields", "experimental": false, "mcp_twin": "inspect_zapier_actions", "internals": "Discover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.listActionInputFields`. CLI: `zapier-sdk list-action-input-fields [options] [app] [action-type] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-actions", "kind": "sdk_function", "key": "list-actions", "title": "zapier-sdk list-actions / zapier.listActions", "summary": "List all actions for a specific app", "body": "# `list-actions`\n\n> List all actions for a specific app\n\n## High-level description\n\nList all actions for a specific app\n\n## Internals\n\nDiscover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.listActions`. CLI: `zapier-sdk list-actions [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-actions [options] [app]\n// TS: const { data } = await zapier.listActions({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App key of actions to list (e.g., 'SlackCLIAPI' or\n action_type?: string | boolean; // --action-type <string> Filter actions by type\n page_size?: string | boolean; // --page-size <number> Number of actions per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Actions)\n\n- Usage: `zapier-sdk list-actions [options] [app]`\n- TypeScript: `zapier.listActions(...)`\n\n## Related functions\n\n- `get-action`\n- `get-action-input-fields-schema`\n- `list-action-input-field-choices`\n- `list-action-input-fields`\n- `run-action`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listActions()`\n- **MCP:** `inspect_zapier_actions / discover_zapier_actions`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-actions [options] [app]\n\nList all actions for a specific app\n\nArguments:\n app App key of actions to list (e.g., 'SlackCLIAPI' or\n slug like 'github')\n\nOptions:\n --action-type <string> Filter actions by type\n --page-size <number> Number of actions per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-actions [options] [app]\n```", "usage": "zapier-sdk list-actions [options] [app]", "signature": "zapier.listActions()", "aliases": ["listActions", "zapier.listActions"], "flags": ["--action-type <string> Filter actions by type", "--page-size <number> Number of actions per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App key of actions to list (e.g., 'SlackCLIAPI' or"], "examples": ["zapier-sdk list-actions [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "actions"], "related": ["get-action", "get-action-input-fields-schema", "list-action-input-field-choices", "list-action-input-fields", "run-action"], "meta": {"surface": "sdk", "category": "Actions", "typescript": "listActions", "experimental": false, "mcp_twin": "inspect_zapier_actions / discover_zapier_actions", "internals": "Discover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.listActions`. CLI: `zapier-sdk list-actions [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:run-action", "kind": "sdk_function", "key": "run-action", "title": "zapier-sdk run-action / zapier.runAction", "summary": "Execute an action with the given inputs", "body": "# `run-action`\n\n> Execute an action with the given inputs\n\n## High-level description\n\nExecute an action with the given inputs\n\n## Internals\n\nDiscover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.runAction`. CLI: `zapier-sdk run-action [options] [app] [action-type] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk run-action [options] [app] [action-type] [action]\n// TS: const { data } = await zapier.runAction({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n action-type?: string; // action-type Action type that matches the action's defined type\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n connection?: string | boolean; // --connection <string> Connection alias or connection ID (UUID or positive\n inputs?: string | boolean; // --inputs <object> Input parameters for the action\n timeout_ms?: string | boolean; // --timeout-ms <number> Maximum time to wait for action completion in\n page_size?: string | boolean; // --page-size <number> Number of results per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Actions)\n\n- Usage: `zapier-sdk run-action [options] [app] [action-type] [action]`\n- TypeScript: `zapier.runAction(...)`\n\n## Related functions\n\n- `get-action`\n- `get-action-input-fields-schema`\n- `list-action-input-field-choices`\n- `list-action-input-fields`\n- `list-actions`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.runAction()`\n- **MCP:** `execute_zapier_read_action / execute_zapier_write_action`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk run-action [options] [app] [action-type] [action]\n\nExecute an action with the given inputs\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n action-type Action type that matches the action's defined type\n action Action key (e.g., 'send_message' or 'find_row')\n\nOptions:\n --connection <string> Connection alias or connection ID (UUID or positive\n integer). Strings that match a key in the connections\n map are resolved against it; otherwise the value is\n used as a connection ID directly. Mutually exclusive\n with connectionId.\n --inputs <object> Input parameters for the action\n --timeout-ms <number> Maximum time to wait for action completion in\n milliseconds (default: 180000)\n --page-size <number> Number of results per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n### Triggers\n\n## Examples\n\n```bash\nzapier-sdk run-action [options] [app] [action-type] [action]\n```", "usage": "zapier-sdk run-action [options] [app] [action-type] [action]", "signature": "zapier.runAction()", "aliases": ["runAction", "zapier.runAction"], "flags": ["--connection <string> Connection alias or connection ID (UUID or positive", "--inputs <object> Input parameters for the action", "--timeout-ms <number> Maximum time to wait for action completion in", "--page-size <number> Number of results per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,", "action-type Action type that matches the action's defined type", "action Action key (e.g., 'send_message' or 'find_row')"], "examples": ["zapier-sdk run-action [options] [app] [action-type] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "actions"], "related": ["get-action", "get-action-input-fields-schema", "list-action-input-field-choices", "list-action-input-fields", "list-actions"], "meta": {"surface": "sdk", "category": "Actions", "typescript": "runAction", "experimental": false, "mcp_twin": "execute_zapier_read_action / execute_zapier_write_action", "internals": "Discover and run partner actions. MCP twins: inspect + execute_zapier_*_action. TypeScript method: `zapier.runAction`. CLI: `zapier-sdk run-action [options] [app] [action-type] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:ack-trigger-inbox-messages", "kind": "sdk_function", "key": "ack-trigger-inbox-messages", "title": "zapier-sdk ack-trigger-inbox-messages / zapier.ackTriggerInboxMessages", "summary": "Acknowledge messages from a lease. Acked messages are removed from the inbox;", "body": "# `ack-trigger-inbox-messages`\n\n> Acknowledge messages from a lease. Acked messages are removed from the inbox;\n\n## High-level description\n\nAcknowledge messages from a lease. Acked messages are removed from the inbox;\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.ackTriggerInboxMessages`. CLI: `zapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]\n// TS: const { data } = await zapier.ackTriggerInboxMessages({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values\n lease?: string; // lease Lease ID returned from leaseTriggerInboxMessages\n messages?: string | boolean; // --messages <value> Specific message IDs to ack. Omit to ack every message in\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]`\n- TypeScript: `zapier.ackTriggerInboxMessages(...)`\n\n## Related functions\n\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.ackTriggerInboxMessages()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]\n\nAcknowledge messages from a lease. Acked messages are removed from the inbox;\nunacked ones return to the available pool when the lease expires.\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values\n are resolved by key via the inbox list endpoint.\n lease Lease ID returned from leaseTriggerInboxMessages\n\nOptions:\n --messages <value> Specific message IDs to ack. Omit to ack every message in\n the lease. (default: [])\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]\n```", "usage": "zapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]", "signature": "zapier.ackTriggerInboxMessages()", "aliases": ["ackTriggerInboxMessages", "zapier.ackTriggerInboxMessages"], "flags": ["--messages <value> Specific message IDs to ack. Omit to ack every message in", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values", "lease Lease ID returned from leaseTriggerInboxMessages"], "examples": ["zapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "ackTriggerInboxMessages", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.ackTriggerInboxMessages`. CLI: `zapier-sdk ack-trigger-inbox-messages [options] [inbox] [lease]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:create-trigger-inbox", "kind": "sdk_function", "key": "create-trigger-inbox", "title": "zapier-sdk create-trigger-inbox / zapier.createTriggerInbox", "summary": "Create a new trigger inbox subscription. Always creates a new inbox; use", "body": "# `create-trigger-inbox`\n\n> Create a new trigger inbox subscription. Always creates a new inbox; use\n\n## High-level description\n\nCreate a new trigger inbox subscription. Always creates a new inbox; use\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.createTriggerInbox`. CLI: `zapier-sdk create-trigger-inbox [options] [app] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk create-trigger-inbox [options] [app] [action]\n// TS: const { data } = await zapier.createTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n key?: string | boolean; // --key <string> Optional inbox key. Auto-generated when omitted.\n connection?: string | boolean; // --connection <string> Connection alias or connection ID. Optional for\n inputs?: string | boolean; // --inputs <object> Input parameters for the trigger subscription\n notification_url?: string | boolean; // --notification-url <string> Webhook URL to POST to when new messages arrive\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk create-trigger-inbox [options] [app] [action]`\n- TypeScript: `zapier.createTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.createTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk create-trigger-inbox [options] [app] [action]\n\nCreate a new trigger inbox subscription. Always creates a new inbox; use\nensureTriggerInbox for get-or-create on a stable key.\n\nArguments:\n app App slug (e.g., 'github'), implementation name\n (e.g., 'SlackCLIAPI'), or versioned ID (e.g.,\n 'github@1.2.3')\n action Action key (e.g., 'send_message' or 'find_row')\n\nOptions:\n --key <string> Optional inbox key. Auto-generated when omitted.\n Throws a conflict error if the key is already in\n use by another subscription.\n --connection <string> Connection alias or connection ID. Optional for\n triggers that don't require auth.\n --inputs <object> Input parameters for the trigger subscription\n --notification-url <string> Webhook URL to POST to when new messages arrive\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk create-trigger-inbox [options] [app] [action]\n```", "usage": "zapier-sdk create-trigger-inbox [options] [app] [action]", "signature": "zapier.createTriggerInbox()", "aliases": ["createTriggerInbox", "zapier.createTriggerInbox"], "flags": ["--key <string> Optional inbox key. Auto-generated when omitted.", "--connection <string> Connection alias or connection ID. Optional for", "--inputs <object> Input parameters for the trigger subscription", "--notification-url <string> Webhook URL to POST to when new messages arrive", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name", "action Action key (e.g., 'send_message' or 'find_row')"], "examples": ["zapier-sdk create-trigger-inbox [options] [app] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "createTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.createTriggerInbox`. CLI: `zapier-sdk create-trigger-inbox [options] [app] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:delete-trigger-inbox", "kind": "sdk_function", "key": "delete-trigger-inbox", "title": "zapier-sdk delete-trigger-inbox / zapier.deleteTriggerInbox", "summary": "Mark a trigger inbox for deletion", "body": "# `delete-trigger-inbox`\n\n> Mark a trigger inbox for deletion\n\n## High-level description\n\nMark a trigger inbox for deletion\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.deleteTriggerInbox`. CLI: `zapier-sdk delete-trigger-inbox [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk delete-trigger-inbox [options] [inbox]\n// TS: const { data } = await zapier.deleteTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk delete-trigger-inbox [options] [inbox]`\n- TypeScript: `zapier.deleteTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.deleteTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk delete-trigger-inbox [options] [inbox]\n\nMark a trigger inbox for deletion\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n resolved by key via the inbox list endpoint.\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk delete-trigger-inbox [options] [inbox]\n```", "usage": "zapier-sdk delete-trigger-inbox [options] [inbox]", "signature": "zapier.deleteTriggerInbox()", "aliases": ["deleteTriggerInbox", "zapier.deleteTriggerInbox"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values are"], "examples": ["zapier-sdk delete-trigger-inbox [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "deleteTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.deleteTriggerInbox`. CLI: `zapier-sdk delete-trigger-inbox [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:drain-trigger-inbox", "kind": "sdk_function", "key": "drain-trigger-inbox", "title": "zapier-sdk drain-trigger-inbox / zapier.drainTriggerInbox", "summary": "Drain an existing trigger inbox: lease currently-available messages and process", "body": "# `drain-trigger-inbox`\n\n> Drain an existing trigger inbox: lease currently-available messages and process\n\n## High-level description\n\nDrain an existing trigger inbox: lease currently-available messages and process\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.drainTriggerInbox`. CLI: `zapier-sdk drain-trigger-inbox [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk drain-trigger-inbox [options] [inbox]\n// TS: const { data } = await zapier.drainTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID\n concurrency?: string | boolean; // --concurrency <number> Per-message handler workers running in parallel.\n lease_limit?: string | boolean; // --lease-limit <number> Per-lease HTTP batch size. Defaults to\n lease_seconds?: string | boolean; // --lease-seconds <number>\n release_on_error?: string | boolean; // --release-on-error If true, errors release the message when the drain\n continue_on_error?: string | boolean; // --continue-on-error If false (default, fail-fast), the first handler\n max_messages?: string | boolean; // --max-messages <number> Cap total messages drained. Defaults to draining\n exec?: string | boolean; // --exec <string> Run a binary per message with no shell\n exec_shell?: string | boolean; // --exec-shell <string> Run a shell command per message. Message JSON is\n json?: string | boolean; // --json Format the drained result as a JSON object on\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk drain-trigger-inbox [options] [inbox]`\n- TypeScript: `zapier.drainTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.drainTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk drain-trigger-inbox [options] [inbox]\n\nDrain an existing trigger inbox: lease currently-available messages and process\nthem via onMessage. Returns when the inbox is empty, maxMessages is reached,\nthe abort signal fires, or a fatal error rejects.\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID\n values are resolved by key via the inbox list\n endpoint.\n\nOptions:\n --concurrency <number> Per-message handler workers running in parallel.\n Defaults to `leaseLimit`, or 1 if neither is set.\n --lease-limit <number> Per-lease HTTP batch size. Defaults to\n `concurrency`, or 1 if neither is set.\n --lease-seconds <number>\n --release-on-error If true, errors release the message when the drain\n finishes. If false (default), errors leave it\n leased until the lease timeout.\n `ZapierReleaseTriggerMessageSignal` always releases\n regardless.\n --continue-on-error If false (default, fail-fast), the first handler\n error rejects and stops the drain. If true, handler\n errors are observed via `onError` and the drain\n continues. SDK-level errors (lease / ack / release)\n reject regardless.\n --max-messages <number> Cap total messages drained. Defaults to draining\n the inbox until empty.\n --exec <string> Run a binary per message with no shell\n interpretation. Message JSON is piped to stdin;\n exit code 0 acks, non-zero records the error per\n the same rules as a thrown handler. Pass extra argv\n after `--` (e.g. `--exec ./handler -- --verbose`).\n Mutually exclusive with --exec-shell and --json.\n --exec-shell <string> Run a shell command per message. Message JSON is\n piped to the subprocess on stdin; exit code 0 acks,\n non-zero records the error per the same rules as a\n thrown handler. Interpreted by the platform's\n default shell (sh on POSIX, cmd.exe on Windows).\n Mutually exclusive with --exec and --json.\n --json Format the drained result as a JSON object on\n stdout: { data, errors }. Use for scripts or\n piping. Mutually exclusive with --exec /\n --exec-shell and the interactive default.\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk drain-trigger-inbox [options] [inbox]\n```", "usage": "zapier-sdk drain-trigger-inbox [options] [inbox]", "signature": "zapier.drainTriggerInbox()", "aliases": ["drainTriggerInbox", "zapier.drainTriggerInbox"], "flags": ["--concurrency <number> Per-message handler workers running in parallel.", "--lease-limit <number> Per-lease HTTP batch size. Defaults to", "--lease-seconds <number>", "--release-on-error If true, errors release the message when the drain", "--continue-on-error If false (default, fail-fast), the first handler", "--max-messages <number> Cap total messages drained. Defaults to draining", "--exec <string> Run a binary per message with no shell", "--exec-shell <string> Run a shell command per message. Message JSON is", "--json Format the drained result as a JSON object on", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID"], "examples": ["zapier-sdk drain-trigger-inbox [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "drainTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.drainTriggerInbox`. CLI: `zapier-sdk drain-trigger-inbox [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:ensure-trigger-inbox", "kind": "sdk_function", "key": "ensure-trigger-inbox", "title": "zapier-sdk ensure-trigger-inbox / zapier.ensureTriggerInbox", "summary": "Get-or-create a trigger inbox by key. Idempotent on (user, account, key):", "body": "# `ensure-trigger-inbox`\n\n> Get-or-create a trigger inbox by key. Idempotent on (user, account, key):\n\n## High-level description\n\nGet-or-create a trigger inbox by key. Idempotent on (user, account, key):\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.ensureTriggerInbox`. CLI: `zapier-sdk ensure-trigger-inbox [options] [key] [app] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk ensure-trigger-inbox [options] [key] [app] [action]\n// TS: const { data } = await zapier.ensureTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n key?: string; // key Inbox key; serves as the idempotency key.\n app?: string; // app App slug (e.g., 'github'), implementation name\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n connection?: string | boolean; // --connection <string> Connection alias or connection ID. Optional for\n inputs?: string | boolean; // --inputs <object> Input parameters for the trigger subscription\n notification_url?: string | boolean; // --notification-url <string> Webhook URL to POST to when new messages arrive\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk ensure-trigger-inbox [options] [key] [app] [action]`\n- TypeScript: `zapier.ensureTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.ensureTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk ensure-trigger-inbox [options] [key] [app] [action]\n\nGet-or-create a trigger inbox by key. Idempotent on (user, account, key):\nreturns the existing inbox if a matching subscription is registered, creates a\nnew one otherwise. Throws ZapierConflictError if the key exists with a\ndifferent subscription.\n\nArguments:\n key Inbox key; serves as the idempotency key.\n Required for ensureTriggerInbox — without one,\n the API mints a fresh inbox each call (use\n createTriggerInbox for that path).\n app App slug (e.g., 'github'), implementation name\n (e.g., 'SlackCLIAPI'), or versioned ID (e.g.,\n 'github@1.2.3')\n action Action key (e.g., 'send_message' or 'find_row')\n\nOptions:\n --connection <string> Connection alias or connection ID. Optional for\n triggers that don't require auth.\n --inputs <object> Input parameters for the trigger subscription\n --notification-url <string> Webhook URL to POST to when new messages arrive\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk ensure-trigger-inbox [options] [key] [app] [action]\n```", "usage": "zapier-sdk ensure-trigger-inbox [options] [key] [app] [action]", "signature": "zapier.ensureTriggerInbox()", "aliases": ["ensureTriggerInbox", "zapier.ensureTriggerInbox"], "flags": ["--connection <string> Connection alias or connection ID. Optional for", "--inputs <object> Input parameters for the trigger subscription", "--notification-url <string> Webhook URL to POST to when new messages arrive", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["key Inbox key; serves as the idempotency key.", "app App slug (e.g., 'github'), implementation name", "action Action key (e.g., 'send_message' or 'find_row')"], "examples": ["zapier-sdk ensure-trigger-inbox [options] [key] [app] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "ensureTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.ensureTriggerInbox`. CLI: `zapier-sdk ensure-trigger-inbox [options] [key] [app] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-trigger-inbox", "kind": "sdk_function", "key": "get-trigger-inbox", "title": "zapier-sdk get-trigger-inbox / zapier.getTriggerInbox", "summary": "Get details of a trigger inbox by ID", "body": "# `get-trigger-inbox`\n\n> Get details of a trigger inbox by ID\n\n## High-level description\n\nGet details of a trigger inbox by ID\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.getTriggerInbox`. CLI: `zapier-sdk get-trigger-inbox [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-trigger-inbox [options] [inbox]\n// TS: const { data } = await zapier.getTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk get-trigger-inbox [options] [inbox]`\n- TypeScript: `zapier.getTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-trigger-inbox [options] [inbox]\n\nGet details of a trigger inbox by ID\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n resolved by key via the inbox list endpoint.\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-trigger-inbox [options] [inbox]\n```", "usage": "zapier-sdk get-trigger-inbox [options] [inbox]", "signature": "zapier.getTriggerInbox()", "aliases": ["getTriggerInbox", "zapier.getTriggerInbox"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values are"], "examples": ["zapier-sdk get-trigger-inbox [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "getTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.getTriggerInbox`. CLI: `zapier-sdk get-trigger-inbox [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-trigger-input-fields-schema", "kind": "sdk_function", "key": "get-trigger-input-fields-schema", "title": "zapier-sdk get-trigger-input-fields-schema / zapier.getTriggerInputFieldsSchema", "summary": "Get the JSON Schema representation of input fields for a trigger. Returns a", "body": "# `get-trigger-input-fields-schema`\n\n> Get the JSON Schema representation of input fields for a trigger. Returns a\n\n## High-level description\n\nGet the JSON Schema representation of input fields for a trigger. Returns a\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.getTriggerInputFieldsSchema`. CLI: `zapier-sdk get-trigger-input-fields-schema [options] [app] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-trigger-input-fields-schema [options] [app] [action]\n// TS: const { data } = await zapier.getTriggerInputFieldsSchema({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App key (e.g., 'SlackCLIAPI' or slug like 'github') to\n action?: string; // action Trigger action key to get the input schema for\n connection?: string | boolean; // --connection <string> Connection alias or connection ID. Required if the\n inputs?: string | boolean; // --inputs <object> Current input values that may affect the schema (e.g.,\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk get-trigger-input-fields-schema [options] [app] [action]`\n- TypeScript: `zapier.getTriggerInputFieldsSchema(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `lease-trigger-inbox-messages`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getTriggerInputFieldsSchema()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-trigger-input-fields-schema [options] [app] [action]\n\nGet the JSON Schema representation of input fields for a trigger. Returns a\nJSON Schema object describing the structure, types, and validation rules for\nthe trigger's input parameters.\n\nArguments:\n app App key (e.g., 'SlackCLIAPI' or slug like 'github') to\n get the input schema for\n action Trigger action key to get the input schema for\n\nOptions:\n --connection <string> Connection alias or connection ID. Required if the\n trigger needs a connection to determine available\n fields.\n --inputs <object> Current input values that may affect the schema (e.g.,\n when fields depend on other field values)\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-trigger-input-fields-schema [options] [app] [action]\n```", "usage": "zapier-sdk get-trigger-input-fields-schema [options] [app] [action]", "signature": "zapier.getTriggerInputFieldsSchema()", "aliases": ["getTriggerInputFieldsSchema", "zapier.getTriggerInputFieldsSchema"], "flags": ["--connection <string> Connection alias or connection ID. Required if the", "--inputs <object> Current input values that may affect the schema (e.g.,", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App key (e.g., 'SlackCLIAPI' or slug like 'github') to", "action Trigger action key to get the input schema for"], "examples": ["zapier-sdk get-trigger-input-fields-schema [options] [app] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "lease-trigger-inbox-messages", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "getTriggerInputFieldsSchema", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.getTriggerInputFieldsSchema`. CLI: `zapier-sdk get-trigger-input-fields-schema [options] [app] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:lease-trigger-inbox-messages", "kind": "sdk_function", "key": "lease-trigger-inbox-messages", "title": "zapier-sdk lease-trigger-inbox-messages / zapier.leaseTriggerInboxMessages", "summary": "Lease up to N messages from a trigger inbox. Returns messages plus a lease ID;", "body": "# `lease-trigger-inbox-messages`\n\n> Lease up to N messages from a trigger inbox. Returns messages plus a lease ID;\n\n## High-level description\n\nLease up to N messages from a trigger inbox. Returns messages plus a lease ID;\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.leaseTriggerInboxMessages`. CLI: `zapier-sdk lease-trigger-inbox-messages [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk lease-trigger-inbox-messages [options] [inbox]\n// TS: const { data } = await zapier.leaseTriggerInboxMessages({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID\n lease_limit?: string | boolean; // --lease-limit <number>\n lease_seconds?: string | boolean; // --lease-seconds <number>\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk lease-trigger-inbox-messages [options] [inbox]`\n- TypeScript: `zapier.leaseTriggerInboxMessages(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `list-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.leaseTriggerInboxMessages()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk lease-trigger-inbox-messages [options] [inbox]\n\nLease up to N messages from a trigger inbox. Returns messages plus a lease ID;\nack within the lease window to remove from the inbox.\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID\n values are resolved by key via the inbox list\n endpoint.\n\nOptions:\n --lease-limit <number>\n --lease-seconds <number>\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk lease-trigger-inbox-messages [options] [inbox]\n```", "usage": "zapier-sdk lease-trigger-inbox-messages [options] [inbox]", "signature": "zapier.leaseTriggerInboxMessages()", "aliases": ["leaseTriggerInboxMessages", "zapier.leaseTriggerInboxMessages"], "flags": ["--lease-limit <number>", "--lease-seconds <number>", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID"], "examples": ["zapier-sdk lease-trigger-inbox-messages [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "list-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "leaseTriggerInboxMessages", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.leaseTriggerInboxMessages`. CLI: `zapier-sdk lease-trigger-inbox-messages [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-trigger-inbox-messages", "kind": "sdk_function", "key": "list-trigger-inbox-messages", "title": "zapier-sdk list-trigger-inbox-messages / zapier.listTriggerInboxMessages", "summary": "List messages in a trigger inbox (no payload, status-only)", "body": "# `list-trigger-inbox-messages`\n\n> List messages in a trigger inbox (no payload, status-only)\n\n## High-level description\n\nList messages in a trigger inbox (no payload, status-only)\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInboxMessages`. CLI: `zapier-sdk list-trigger-inbox-messages [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-trigger-inbox-messages [options] [inbox]\n// TS: const { data } = await zapier.listTriggerInboxMessages({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values\n page_size?: string | boolean; // --page-size <number> Number of messages per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Pagination cursor\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk list-trigger-inbox-messages [options] [inbox]`\n- TypeScript: `zapier.listTriggerInboxMessages(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTriggerInboxMessages()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-trigger-inbox-messages [options] [inbox]\n\nList messages in a trigger inbox (no payload, status-only)\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values\n are resolved by key via the inbox list endpoint.\n\nOptions:\n --page-size <number> Number of messages per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Pagination cursor\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-trigger-inbox-messages [options] [inbox]\n```", "usage": "zapier-sdk list-trigger-inbox-messages [options] [inbox]", "signature": "zapier.listTriggerInboxMessages()", "aliases": ["listTriggerInboxMessages", "zapier.listTriggerInboxMessages"], "flags": ["--page-size <number> Number of messages per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Pagination cursor", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values"], "examples": ["zapier-sdk list-trigger-inbox-messages [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "listTriggerInboxMessages", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInboxMessages`. CLI: `zapier-sdk list-trigger-inbox-messages [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-trigger-inboxes", "kind": "sdk_function", "key": "list-trigger-inboxes", "title": "zapier-sdk list-trigger-inboxes / zapier.listTriggerInboxes", "summary": "List all trigger inboxes for the authenticated user", "body": "# `list-trigger-inboxes`\n\n> List all trigger inboxes for the authenticated user\n\n## High-level description\n\nList all trigger inboxes for the authenticated user\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInboxes`. CLI: `zapier-sdk list-trigger-inboxes [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-trigger-inboxes [options]\n// TS: const { data } = await zapier.listTriggerInboxes({ ... })\n```\n```ts\ntype Input = {\n key?: string | boolean; // --key <string> Filter by inbox key (exact match). Keys are unique per\n status?: string | boolean; // --status <string> Filter by inbox status\n page_size?: string | boolean; // --page-size <number> Number of inboxes per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor (offset) to start from for pagination\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk list-trigger-inboxes [options]`\n- TypeScript: `zapier.listTriggerInboxes(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTriggerInboxes()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-trigger-inboxes [options]\n\nList all trigger inboxes for the authenticated user\n\nOptions:\n --key <string> Filter by inbox key (exact match). Keys are unique per\n (user, account), so this returns at most one inbox.\n --status <string> Filter by inbox status\n --page-size <number> Number of inboxes per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor (offset) to start from for pagination\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-trigger-inboxes [options]\n```", "usage": "zapier-sdk list-trigger-inboxes [options]", "signature": "zapier.listTriggerInboxes()", "aliases": ["listTriggerInboxes", "zapier.listTriggerInboxes"], "flags": ["--key <string> Filter by inbox key (exact match). Keys are unique per", "--status <string> Filter by inbox status", "--page-size <number> Number of inboxes per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor (offset) to start from for pagination", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk list-trigger-inboxes [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "listTriggerInboxes", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInboxes`. CLI: `zapier-sdk list-trigger-inboxes [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-trigger-input-field-choices", "kind": "sdk_function", "key": "list-trigger-input-field-choices", "title": "zapier-sdk list-trigger-input-field-choices / zapier.listTriggerInputFieldChoices", "summary": "Get the available choices for a dynamic dropdown input field on a trigger", "body": "# `list-trigger-input-field-choices`\n\n> Get the available choices for a dynamic dropdown input field on a trigger\n\n## High-level description\n\nGet the available choices for a dynamic dropdown input field on a trigger\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInputFieldChoices`. CLI: `zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]\n// TS: const { data } = await zapier.listTriggerInputFieldChoices({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n input-field?: string; // input-field Input field key to get choices for\n connection?: string | boolean; // --connection <string> Connection alias or connection ID. Required if the\n inputs?: string | boolean; // --inputs <object> Current input values that may affect available choices\n page?: string | boolean; // --page <number> Page number for paginated results\n page_size?: string | boolean; // --page-size <number> Number of choices per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]`\n- TypeScript: `zapier.listTriggerInputFieldChoices(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTriggerInputFieldChoices()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]\n\nGet the available choices for a dynamic dropdown input field on a trigger\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n action Action key (e.g., 'send_message' or 'find_row')\n input-field Input field key to get choices for\n\nOptions:\n --connection <string> Connection alias or connection ID. Required if the\n trigger needs a connection to populate dynamic\n dropdown options.\n --inputs <object> Current input values that may affect available choices\n --page <number> Page number for paginated results\n --page-size <number> Number of choices per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]\n```", "usage": "zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]", "signature": "zapier.listTriggerInputFieldChoices()", "aliases": ["listTriggerInputFieldChoices", "zapier.listTriggerInputFieldChoices"], "flags": ["--connection <string> Connection alias or connection ID. Required if the", "--inputs <object> Current input values that may affect available choices", "--page <number> Page number for paginated results", "--page-size <number> Number of choices per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,", "action Action key (e.g., 'send_message' or 'find_row')", "input-field Input field key to get choices for"], "examples": ["zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "listTriggerInputFieldChoices", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInputFieldChoices`. CLI: `zapier-sdk list-trigger-input-field-choices [options] [app] [action] [input-field]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-trigger-input-fields", "kind": "sdk_function", "key": "list-trigger-input-fields", "title": "zapier-sdk list-trigger-input-fields / zapier.listTriggerInputFields", "summary": "Get the input fields required for a specific trigger", "body": "# `list-trigger-input-fields`\n\n> Get the input fields required for a specific trigger\n\n## High-level description\n\nGet the input fields required for a specific trigger\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInputFields`. CLI: `zapier-sdk list-trigger-input-fields [options] [app] [action]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-trigger-input-fields [options] [app] [action]\n// TS: const { data } = await zapier.listTriggerInputFields({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App slug (e.g., 'github'), implementation name (e.g.,\n action?: string; // action Action key (e.g., 'send_message' or 'find_row')\n connection?: string | boolean; // --connection <string> Connection alias or connection ID. Required if the\n inputs?: string | boolean; // --inputs <object> Current input values that may affect available fields\n page_size?: string | boolean; // --page-size <number> Number of input fields per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk list-trigger-input-fields [options] [app] [action]`\n- TypeScript: `zapier.listTriggerInputFields(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTriggerInputFields()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-trigger-input-fields [options] [app] [action]\n\nGet the input fields required for a specific trigger\n\nArguments:\n app App slug (e.g., 'github'), implementation name (e.g.,\n 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')\n action Action key (e.g., 'send_message' or 'find_row')\n\nOptions:\n --connection <string> Connection alias or connection ID. Required if the\n trigger needs a connection to determine available\n fields.\n --inputs <object> Current input values that may affect available fields\n --page-size <number> Number of input fields per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-trigger-input-fields [options] [app] [action]\n```", "usage": "zapier-sdk list-trigger-input-fields [options] [app] [action]", "signature": "zapier.listTriggerInputFields()", "aliases": ["listTriggerInputFields", "zapier.listTriggerInputFields"], "flags": ["--connection <string> Connection alias or connection ID. Required if the", "--inputs <object> Current input values that may affect available fields", "--page-size <number> Number of input fields per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App slug (e.g., 'github'), implementation name (e.g.,", "action Action key (e.g., 'send_message' or 'find_row')"], "examples": ["zapier-sdk list-trigger-input-fields [options] [app] [action]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "listTriggerInputFields", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggerInputFields`. CLI: `zapier-sdk list-trigger-input-fields [options] [app] [action]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-triggers", "kind": "sdk_function", "key": "list-triggers", "title": "zapier-sdk list-triggers / zapier.listTriggers", "summary": "List all triggers for a specific app", "body": "# `list-triggers`\n\n> List all triggers for a specific app\n\n## High-level description\n\nList all triggers for a specific app\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggers`. CLI: `zapier-sdk list-triggers [options] [app]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-triggers [options] [app]\n// TS: const { data } = await zapier.listTriggers({ ... })\n```\n```ts\ntype Input = {\n app?: string; // app App key of triggers to list (e.g., 'SlackCLIAPI' or\n page_size?: string | boolean; // --page-size <number> Number of triggers per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk list-triggers [options] [app]`\n- TypeScript: `zapier.listTriggers(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTriggers()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-triggers [options] [app]\n\nList all triggers for a specific app\n\nArguments:\n app App key of triggers to list (e.g., 'SlackCLIAPI' or\n slug like 'github')\n\nOptions:\n --page-size <number> Number of triggers per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-triggers [options] [app]\n```", "usage": "zapier-sdk list-triggers [options] [app]", "signature": "zapier.listTriggers()", "aliases": ["listTriggers", "zapier.listTriggers"], "flags": ["--page-size <number> Number of triggers per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["app App key of triggers to list (e.g., 'SlackCLIAPI' or"], "examples": ["zapier-sdk list-triggers [options] [app]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "listTriggers", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.listTriggers`. CLI: `zapier-sdk list-triggers [options] [app]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:pause-trigger-inbox", "kind": "sdk_function", "key": "pause-trigger-inbox", "title": "zapier-sdk pause-trigger-inbox / zapier.pauseTriggerInbox", "summary": "Pause a trigger inbox; events stop being collected", "body": "# `pause-trigger-inbox`\n\n> Pause a trigger inbox; events stop being collected\n\n## High-level description\n\nPause a trigger inbox; events stop being collected\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.pauseTriggerInbox`. CLI: `zapier-sdk pause-trigger-inbox [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk pause-trigger-inbox [options] [inbox]\n// TS: const { data } = await zapier.pauseTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk pause-trigger-inbox [options] [inbox]`\n- TypeScript: `zapier.pauseTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.pauseTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk pause-trigger-inbox [options] [inbox]\n\nPause a trigger inbox; events stop being collected\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n resolved by key via the inbox list endpoint.\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk pause-trigger-inbox [options] [inbox]\n```", "usage": "zapier-sdk pause-trigger-inbox [options] [inbox]", "signature": "zapier.pauseTriggerInbox()", "aliases": ["pauseTriggerInbox", "zapier.pauseTriggerInbox"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values are"], "examples": ["zapier-sdk pause-trigger-inbox [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "pauseTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.pauseTriggerInbox`. CLI: `zapier-sdk pause-trigger-inbox [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:release-trigger-inbox-messages", "kind": "sdk_function", "key": "release-trigger-inbox-messages", "title": "zapier-sdk release-trigger-inbox-messages / zapier.releaseTriggerInboxMessages", "summary": "Release messages from a lease back to the inbox without acknowledging them.", "body": "# `release-trigger-inbox-messages`\n\n> Release messages from a lease back to the inbox without acknowledging them.\n\n## High-level description\n\nRelease messages from a lease back to the inbox without acknowledging them.\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.releaseTriggerInboxMessages`. CLI: `zapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]\n// TS: const { data } = await zapier.releaseTriggerInboxMessages({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values\n lease?: string; // lease Lease ID returned from leaseTriggerInboxMessages\n messages?: string | boolean; // --messages <value> Specific message IDs to release. Omit to release every\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]`\n- TypeScript: `zapier.releaseTriggerInboxMessages(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.releaseTriggerInboxMessages()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]\n\nRelease messages from a lease back to the inbox without acknowledging them.\nReleased messages become immediately available for re-leasing. The lease\nattempt still counts against the per-message lease limit; releasing does not\nrefund the attempt.\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values\n are resolved by key via the inbox list endpoint.\n lease Lease ID returned from leaseTriggerInboxMessages\n\nOptions:\n --messages <value> Specific message IDs to release. Omit to release every\n message in the lease. (default: [])\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]\n```", "usage": "zapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]", "signature": "zapier.releaseTriggerInboxMessages()", "aliases": ["releaseTriggerInboxMessages", "zapier.releaseTriggerInboxMessages"], "flags": ["--messages <value> Specific message IDs to release. Omit to release every", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values", "lease Lease ID returned from leaseTriggerInboxMessages"], "examples": ["zapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "releaseTriggerInboxMessages", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.releaseTriggerInboxMessages`. CLI: `zapier-sdk release-trigger-inbox-messages [options] [inbox] [lease]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:resume-trigger-inbox", "kind": "sdk_function", "key": "resume-trigger-inbox", "title": "zapier-sdk resume-trigger-inbox / zapier.resumeTriggerInbox", "summary": "Resume a paused trigger inbox; events resume being collected", "body": "# `resume-trigger-inbox`\n\n> Resume a paused trigger inbox; events resume being collected\n\n## High-level description\n\nResume a paused trigger inbox; events resume being collected\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.resumeTriggerInbox`. CLI: `zapier-sdk resume-trigger-inbox [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk resume-trigger-inbox [options] [inbox]\n// TS: const { data } = await zapier.resumeTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk resume-trigger-inbox [options] [inbox]`\n- TypeScript: `zapier.resumeTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.resumeTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk resume-trigger-inbox [options] [inbox]\n\nResume a paused trigger inbox; events resume being collected\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values are\n resolved by key via the inbox list endpoint.\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk resume-trigger-inbox [options] [inbox]\n```", "usage": "zapier-sdk resume-trigger-inbox [options] [inbox]", "signature": "zapier.resumeTriggerInbox()", "aliases": ["resumeTriggerInbox", "zapier.resumeTriggerInbox"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values are"], "examples": ["zapier-sdk resume-trigger-inbox [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "resumeTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.resumeTriggerInbox`. CLI: `zapier-sdk resume-trigger-inbox [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:update-trigger-inbox", "kind": "sdk_function", "key": "update-trigger-inbox", "title": "zapier-sdk update-trigger-inbox / zapier.updateTriggerInbox", "summary": "Update settings on an existing trigger inbox", "body": "# `update-trigger-inbox`\n\n> Update settings on an existing trigger inbox\n\n## High-level description\n\nUpdate settings on an existing trigger inbox\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.updateTriggerInbox`. CLI: `zapier-sdk update-trigger-inbox [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk update-trigger-inbox [options] [inbox]\n// TS: const { data } = await zapier.updateTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID\n notification_url?: string | boolean; // --notification-url <string> Webhook URL to POST to when new messages arrive.\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk update-trigger-inbox [options] [inbox]`\n- TypeScript: `zapier.updateTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.updateTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk update-trigger-inbox [options] [inbox]\n\nUpdate settings on an existing trigger inbox\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID\n values are resolved by key via the inbox list\n endpoint.\n\nOptions:\n --notification-url <string> Webhook URL to POST to when new messages arrive.\n Pass null to clear.\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk update-trigger-inbox [options] [inbox]\n```", "usage": "zapier-sdk update-trigger-inbox [options] [inbox]", "signature": "zapier.updateTriggerInbox()", "aliases": ["updateTriggerInbox", "zapier.updateTriggerInbox"], "flags": ["--notification-url <string> Webhook URL to POST to when new messages arrive.", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID"], "examples": ["zapier-sdk update-trigger-inbox [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "updateTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.updateTriggerInbox`. CLI: `zapier-sdk update-trigger-inbox [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:watch-trigger-inbox", "kind": "sdk_function", "key": "watch-trigger-inbox", "title": "zapier-sdk watch-trigger-inbox / zapier.watchTriggerInbox", "summary": "Continuously consume a trigger inbox: drain currently-available messages, then", "body": "# `watch-trigger-inbox`\n\n> Continuously consume a trigger inbox: drain currently-available messages, then\n\n## High-level description\n\nContinuously consume a trigger inbox: drain currently-available messages, then\n\n## Internals\n\nTrigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.watchTriggerInbox`. CLI: `zapier-sdk watch-trigger-inbox [options] [inbox]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk watch-trigger-inbox [options] [inbox]\n// TS: const { data } = await zapier.watchTriggerInbox({ ... })\n```\n```ts\ntype Input = {\n inbox?: string; // inbox Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoi\n leaseLimit?: string | boolean; // --concurrency <number> Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set.\n concurrency?: string | boolean; // --lease-limit <number> Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set.\n lease_seconds?: string | boolean; // --lease-seconds <number>\n ZapierReleaseTriggerMessageSignal?: string | boolean; // --release-on-error If true, errors release the message when the drain finishes. If false (default), errors leave it leas\n onError?: string | boolean; // --continue-on-error If false (default, fail-fast), the first handler error rejects and stops the drain. If true, handler \n max_drain_interval_seconds?: string | boolean; // --max-drain-interval-seconds <number> Maximum seconds between safety drain attempts (default: 300). The watcher subscribes to SSE notificat\n ?: string | boolean; // --exec <string> Run a binary per message with no shell interpretation. Message JSON is piped to stdin; exit code 0 ac\n exec_shell?: string | boolean; // --exec-shell <string> Run a shell command per message. Message JSON is piped to the subprocess on stdin; exit code 0 acks, \n json?: string | boolean; // --json Stream each message as JSON to stdout (one record per line, NDJSON), acking as each write completes. \n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Triggers)\n\n- Usage: `zapier-sdk watch-trigger-inbox [options] [inbox]`\n- TypeScript: `zapier.watchTriggerInbox(...)`\n\n## Related functions\n\n- `ack-trigger-inbox-messages`\n- `create-trigger-inbox`\n- `delete-trigger-inbox`\n- `drain-trigger-inbox`\n- `ensure-trigger-inbox`\n- `get-trigger-inbox`\n- `get-trigger-input-fields-schema`\n- `lease-trigger-inbox-messages`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.watchTriggerInbox()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk watch-trigger-inbox [options] [inbox]\n\nContinuously consume a trigger inbox: drain currently-available messages, then\nsubscribe to SSE notifications for new arrivals, until aborted. Stop via the\n`signal` AbortSignal or by throwing `ZapierAbortDrainSignal` from a handler.\nTransient drain failures (5xx, 429, network blips) retry indefinitely with\nbounded backoff; real-time wake-up and drain health warnings print to stderr.\nResolves cleanly on abort; rejects on a fatal error or a fail-fast handler\nerror. stdout (including --json NDJSON) is unaffected.\n\nArguments:\n inbox Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint.\n\nOptions:\n --concurrency <number> Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set.\n --lease-limit <number> Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set.\n --lease-seconds <number>\n --release-on-error If true, errors release the message when the drain finishes. If false (default), errors leave it leased until the lease timeout. `ZapierReleaseTriggerMessageSignal` always releases regardless.\n --continue-on-error If false (default, fail-fast), the first handler error rejects and stops the drain. If true, handler errors are observed via `onError` and the drain continues. SDK-level errors (lease / ack / release) reject regardless.\n --max-drain-interval-seconds <number> Maximum seconds between safety drain attempts (default: 300). The watcher subscribes to SSE notifications for near-real-time wake-ups; this interval is the backstop that guarantees forward progress if SSE events are missed or the connection drops undetected.\n --exec <string> Run a binary per message with no shell interpretation. Message JSON is piped to stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Pass extra argv after `--` (e.g. `--exec ./handler -- --verbose`). Mutually exclusive with --exec-shell and --json.\n --exec-shell <string> Run a shell command per message. Message JSON is piped to the subprocess on stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Interpreted by the platform's default shell (sh on POSIX, cmd.exe on Windows). Mutually exclusive with --exec and --json.\n --json Stream each message as JSON to stdout (one record per line, NDJSON), acking as each write completes. Use for piping to other tools. Mutually exclusive with --exec / --exec-shell and the interactive default.\n -h, --help Display help for command\n```\n\n### Tables\n\n## Examples\n\n```bash\nzapier-sdk watch-trigger-inbox [options] [inbox]\n```", "usage": "zapier-sdk watch-trigger-inbox [options] [inbox]", "signature": "zapier.watchTriggerInbox()", "aliases": ["watchTriggerInbox", "zapier.watchTriggerInbox"], "flags": ["--concurrency <number> Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set.", "--lease-limit <number> Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set.", "--lease-seconds <number>", "--release-on-error If true, errors release the message when the drain finishes. If false (default), errors leave it leased until the lease timeout. `ZapierReleaseTriggerMessageSignal` always releases regardless.", "--continue-on-error If false (default, fail-fast), the first handler error rejects and stops the drain. If true, handler errors are observed via `onError` and the drain continues. SDK-level errors (lease / ack / release) reject regardless.", "--max-drain-interval-seconds <number> Maximum seconds between safety drain attempts (default: 300). The watcher subscribes to SSE notifications for near-real-time wake-ups; this interval is the backstop that guarantees forward progress if SSE events are missed or the connection drops undetected.", "--exec <string> Run a binary per message with no shell interpretation. Message JSON is piped to stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Pass extra argv after `--` (e.g. `--exec ./handler -- --verbose`). Mutually exclusive with --exec-shell and --json.", "--exec-shell <string> Run a shell command per message. Message JSON is piped to the subprocess on stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Interpreted by the platform's default shell (sh on POSIX, cmd.exe on Windows). Mutually exclusive with --exec and --json.", "--json Stream each message as JSON to stdout (one record per line, NDJSON), acking as each write completes. Use for piping to other tools. Mutually exclusive with --exec / --exec-shell and the interactive default.", "-h, --help Display help for command"], "args": ["inbox Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint."], "examples": ["zapier-sdk watch-trigger-inbox [options] [inbox]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "triggers"], "related": ["ack-trigger-inbox-messages", "create-trigger-inbox", "delete-trigger-inbox", "drain-trigger-inbox", "ensure-trigger-inbox", "get-trigger-inbox", "get-trigger-input-fields-schema", "lease-trigger-inbox-messages"], "meta": {"surface": "sdk", "category": "Triggers", "typescript": "watchTriggerInbox", "experimental": false, "mcp_twin": null, "internals": "Trigger Inbox API — subscribe to partner events, lease/ack messages. TypeScript method: `zapier.watchTriggerInbox`. CLI: `zapier-sdk watch-trigger-inbox [options] [inbox]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:create-table", "kind": "sdk_function", "key": "create-table", "title": "zapier-sdk create-table / zapier.createTable", "summary": "Create a new table", "body": "# `create-table`\n\n> Create a new table\n\n## High-level description\n\nCreate a new table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.createTable`. CLI: `zapier-sdk create-table [options] [name]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk create-table [options] [name]\n// TS: const { data } = await zapier.createTable({ ... })\n```\n```ts\ntype Input = {\n name?: string; // name The name for the new table\n description?: string | boolean; // --description <string> An optional description of the table\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk create-table [options] [name]`\n- TypeScript: `zapier.createTable(...)`\n\n## Related functions\n\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.createTable()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk create-table [options] [name]\n\nCreate a new table\n\nArguments:\n name The name for the new table\n\nOptions:\n --description <string> An optional description of the table\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk create-table [options] [name]\n```", "usage": "zapier-sdk create-table [options] [name]", "signature": "zapier.createTable()", "aliases": ["createTable", "zapier.createTable"], "flags": ["--description <string> An optional description of the table", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["name The name for the new table"], "examples": ["zapier-sdk create-table [options] [name]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "get-table-record", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "createTable", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.createTable`. CLI: `zapier-sdk create-table [options] [name]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:create-table-fields", "kind": "sdk_function", "key": "create-table-fields", "title": "zapier-sdk create-table-fields / zapier.createTableFields", "summary": "Create one or more fields in a table", "body": "# `create-table-fields`\n\n> Create one or more fields in a table\n\n## High-level description\n\nCreate one or more fields in a table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.createTableFields`. CLI: `zapier-sdk create-table-fields [options] [table] [fields]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk create-table-fields [options] [table] [fields]\n// TS: const { data } = await zapier.createTableFields({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n fields?: string; // fields Array of field definitions to create\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk create-table-fields [options] [table] [fields]`\n- TypeScript: `zapier.createTableFields(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.createTableFields()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk create-table-fields [options] [table] [fields]\n\nCreate one or more fields in a table\n\nArguments:\n table The unique identifier of the table\n fields Array of field definitions to create\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk create-table-fields [options] [table] [fields]\n```", "usage": "zapier-sdk create-table-fields [options] [table] [fields]", "signature": "zapier.createTableFields()", "aliases": ["createTableFields", "zapier.createTableFields"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table", "fields Array of field definitions to create"], "examples": ["zapier-sdk create-table-fields [options] [table] [fields]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "get-table-record", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "createTableFields", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.createTableFields`. CLI: `zapier-sdk create-table-fields [options] [table] [fields]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:create-table-records", "kind": "sdk_function", "key": "create-table-records", "title": "zapier-sdk create-table-records / zapier.createTableRecords", "summary": "Create one or more records in a table", "body": "# `create-table-records`\n\n> Create one or more records in a table\n\n## High-level description\n\nCreate one or more records in a table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.createTableRecords`. CLI: `zapier-sdk create-table-records [options] [table] [records]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk create-table-records [options] [table] [records]\n// TS: const { data } = await zapier.createTableRecords({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n records?: string; // records Array of records to create (max 100)\n key_mode?: string | boolean; // --key-mode <string> How to interpret field keys in record data. \"names\"\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk create-table-records [options] [table] [records]`\n- TypeScript: `zapier.createTableRecords(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.createTableRecords()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk create-table-records [options] [table] [records]\n\nCreate one or more records in a table\n\nArguments:\n table The unique identifier of the table\n records Array of records to create (max 100)\n\nOptions:\n --key-mode <string> How to interpret field keys in record data. \"names\"\n (default) uses human-readable field names, \"ids\" uses\n raw field IDs (f1, f2). (default: \"names\")\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk create-table-records [options] [table] [records]\n```", "usage": "zapier-sdk create-table-records [options] [table] [records]", "signature": "zapier.createTableRecords()", "aliases": ["createTableRecords", "zapier.createTableRecords"], "flags": ["--key-mode <string> How to interpret field keys in record data. \"names\"", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table", "records Array of records to create (max 100)"], "examples": ["zapier-sdk create-table-records [options] [table] [records]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "get-table-record", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "createTableRecords", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.createTableRecords`. CLI: `zapier-sdk create-table-records [options] [table] [records]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:delete-table", "kind": "sdk_function", "key": "delete-table", "title": "zapier-sdk delete-table / zapier.deleteTable", "summary": "Delete a table by its ID", "body": "# `delete-table`\n\n> Delete a table by its ID\n\n## High-level description\n\nDelete a table by its ID\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.deleteTable`. CLI: `zapier-sdk delete-table [options] [table]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk delete-table [options] [table]\n// TS: const { data } = await zapier.deleteTable({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk delete-table [options] [table]`\n- TypeScript: `zapier.deleteTable(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.deleteTable()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk delete-table [options] [table]\n\nDelete a table by its ID\n\nArguments:\n table The unique identifier of the table\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk delete-table [options] [table]\n```", "usage": "zapier-sdk delete-table [options] [table]", "signature": "zapier.deleteTable()", "aliases": ["deleteTable", "zapier.deleteTable"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table"], "examples": ["zapier-sdk delete-table [options] [table]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table-fields", "delete-table-records", "get-table", "get-table-record", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "deleteTable", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.deleteTable`. CLI: `zapier-sdk delete-table [options] [table]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:delete-table-fields", "kind": "sdk_function", "key": "delete-table-fields", "title": "zapier-sdk delete-table-fields / zapier.deleteTableFields", "summary": "Delete one or more fields from a table", "body": "# `delete-table-fields`\n\n> Delete one or more fields from a table\n\n## High-level description\n\nDelete one or more fields from a table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.deleteTableFields`. CLI: `zapier-sdk delete-table-fields [options] [table] [fields]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk delete-table-fields [options] [table] [fields]\n// TS: const { data } = await zapier.deleteTableFields({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n fields?: string; // fields Fields to operate on. Accepts field names (e.g., \"Email\") or IDs\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk delete-table-fields [options] [table] [fields]`\n- TypeScript: `zapier.deleteTableFields(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.deleteTableFields()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk delete-table-fields [options] [table] [fields]\n\nDelete one or more fields from a table\n\nArguments:\n table The unique identifier of the table\n fields Fields to operate on. Accepts field names (e.g., \"Email\") or IDs\n (e.g., \"f6\", \"6\", or 6).\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk delete-table-fields [options] [table] [fields]\n```", "usage": "zapier-sdk delete-table-fields [options] [table] [fields]", "signature": "zapier.deleteTableFields()", "aliases": ["deleteTableFields", "zapier.deleteTableFields"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table", "fields Fields to operate on. Accepts field names (e.g., \"Email\") or IDs"], "examples": ["zapier-sdk delete-table-fields [options] [table] [fields]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-records", "get-table", "get-table-record", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "deleteTableFields", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.deleteTableFields`. CLI: `zapier-sdk delete-table-fields [options] [table] [fields]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:delete-table-records", "kind": "sdk_function", "key": "delete-table-records", "title": "zapier-sdk delete-table-records / zapier.deleteTableRecords", "summary": "Delete one or more records from a table", "body": "# `delete-table-records`\n\n> Delete one or more records from a table\n\n## High-level description\n\nDelete one or more records from a table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.deleteTableRecords`. CLI: `zapier-sdk delete-table-records [options] [table] [records]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk delete-table-records [options] [table] [records]\n// TS: const { data } = await zapier.deleteTableRecords({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n records?: string; // records Record IDs to operate on\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk delete-table-records [options] [table] [records]`\n- TypeScript: `zapier.deleteTableRecords(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `get-table`\n- `get-table-record`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.deleteTableRecords()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk delete-table-records [options] [table] [records]\n\nDelete one or more records from a table\n\nArguments:\n table The unique identifier of the table\n records Record IDs to operate on\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk delete-table-records [options] [table] [records]\n```", "usage": "zapier-sdk delete-table-records [options] [table] [records]", "signature": "zapier.deleteTableRecords()", "aliases": ["deleteTableRecords", "zapier.deleteTableRecords"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table", "records Record IDs to operate on"], "examples": ["zapier-sdk delete-table-records [options] [table] [records]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "get-table", "get-table-record", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "deleteTableRecords", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.deleteTableRecords`. CLI: `zapier-sdk delete-table-records [options] [table] [records]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-table", "kind": "sdk_function", "key": "get-table", "title": "zapier-sdk get-table / zapier.getTable", "summary": "Get detailed information about a specific table", "body": "# `get-table`\n\n> Get detailed information about a specific table\n\n## High-level description\n\nGet detailed information about a specific table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.getTable`. CLI: `zapier-sdk get-table [options] [table]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-table [options] [table]\n// TS: const { data } = await zapier.getTable({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk get-table [options] [table]`\n- TypeScript: `zapier.getTable(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table-record`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getTable()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-table [options] [table]\n\nGet detailed information about a specific table\n\nArguments:\n table The unique identifier of the table\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-table [options] [table]\n```", "usage": "zapier-sdk get-table [options] [table]", "signature": "zapier.getTable()", "aliases": ["getTable", "zapier.getTable"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table"], "examples": ["zapier-sdk get-table [options] [table]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table-record", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "getTable", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.getTable`. CLI: `zapier-sdk get-table [options] [table]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-table-record", "kind": "sdk_function", "key": "get-table-record", "title": "zapier-sdk get-table-record / zapier.getTableRecord", "summary": "Get a single record from a table by ID", "body": "# `get-table-record`\n\n> Get a single record from a table by ID\n\n## High-level description\n\nGet a single record from a table by ID\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.getTableRecord`. CLI: `zapier-sdk get-table-record [options] [table] [record]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-table-record [options] [table] [record]\n// TS: const { data } = await zapier.getTableRecord({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n record?: string; // record The unique identifier of the record\n key_mode?: string | boolean; // --key-mode <string> How to interpret field keys in record data. \"names\"\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk get-table-record [options] [table] [record]`\n- TypeScript: `zapier.getTableRecord(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `list-table-fields`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getTableRecord()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-table-record [options] [table] [record]\n\nGet a single record from a table by ID\n\nArguments:\n table The unique identifier of the table\n record The unique identifier of the record\n\nOptions:\n --key-mode <string> How to interpret field keys in record data. \"names\"\n (default) uses human-readable field names, \"ids\" uses\n raw field IDs (f1, f2). (default: \"names\")\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-table-record [options] [table] [record]\n```", "usage": "zapier-sdk get-table-record [options] [table] [record]", "signature": "zapier.getTableRecord()", "aliases": ["getTableRecord", "zapier.getTableRecord"], "flags": ["--key-mode <string> How to interpret field keys in record data. \"names\"", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table", "record The unique identifier of the record"], "examples": ["zapier-sdk get-table-record [options] [table] [record]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "list-table-fields"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "getTableRecord", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.getTableRecord`. CLI: `zapier-sdk get-table-record [options] [table] [record]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-table-fields", "kind": "sdk_function", "key": "list-table-fields", "title": "zapier-sdk list-table-fields / zapier.listTableFields", "summary": "List fields for a table", "body": "# `list-table-fields`\n\n> List fields for a table\n\n## High-level description\n\nList fields for a table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.listTableFields`. CLI: `zapier-sdk list-table-fields [options] [table]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-table-fields [options] [table]\n// TS: const { data } = await zapier.listTableFields({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n fields?: string | boolean; // --fields <value> (default: [])\n trash?: string | boolean; // --trash <string> Control soft-deleted item visibility. \"exclude\" (default)\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk list-table-fields [options] [table]`\n- TypeScript: `zapier.listTableFields(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTableFields()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-table-fields [options] [table]\n\nList fields for a table\n\nArguments:\n table The unique identifier of the table\n\nOptions:\n --fields <value> (default: [])\n --trash <string> Control soft-deleted item visibility. \"exclude\" (default)\n returns active items only, \"include\" returns both active\n and soft-deleted, \"only\" returns soft-deleted items only.\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-table-fields [options] [table]\n```", "usage": "zapier-sdk list-table-fields [options] [table]", "signature": "zapier.listTableFields()", "aliases": ["listTableFields", "zapier.listTableFields"], "flags": ["--fields <value> (default: [])", "--trash <string> Control soft-deleted item visibility. \"exclude\" (default)", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table"], "examples": ["zapier-sdk list-table-fields [options] [table]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "get-table-record"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "listTableFields", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.listTableFields`. CLI: `zapier-sdk list-table-fields [options] [table]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-table-records", "kind": "sdk_function", "key": "list-table-records", "title": "zapier-sdk list-table-records / zapier.listTableRecords", "summary": "List records in a table with optional filtering and sorting", "body": "# `list-table-records`\n\n> List records in a table with optional filtering and sorting\n\n## High-level description\n\nList records in a table with optional filtering and sorting\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.listTableRecords`. CLI: `zapier-sdk list-table-records [options] [table]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-table-records [options] [table]\n// TS: const { data } = await zapier.listTableRecords({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n filters?: string | boolean; // --filters <value> Filter conditions for the query (default: [])\n sort?: string | boolean; // --sort <object> Sort records by a field\n page_size?: string | boolean; // --page-size <number> Number of records per page (max 1000)\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n key_mode?: string | boolean; // --key-mode <string> How to interpret field keys in record data. \"names\"\n trash?: string | boolean; // --trash <string> Control soft-deleted item visibility. \"exclude\"\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk list-table-records [options] [table]`\n- TypeScript: `zapier.listTableRecords(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTableRecords()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-table-records [options] [table]\n\nList records in a table with optional filtering and sorting\n\nArguments:\n table The unique identifier of the table\n\nOptions:\n --filters <value> Filter conditions for the query (default: [])\n --sort <object> Sort records by a field\n --page-size <number> Number of records per page (max 1000)\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --key-mode <string> How to interpret field keys in record data. \"names\"\n (default) uses human-readable field names, \"ids\" uses\n raw field IDs (f1, f2). (default: \"names\")\n --trash <string> Control soft-deleted item visibility. \"exclude\"\n (default) returns active items only, \"include\" returns\n both active and soft-deleted, \"only\" returns\n soft-deleted items only.\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-table-records [options] [table]\n```", "usage": "zapier-sdk list-table-records [options] [table]", "signature": "zapier.listTableRecords()", "aliases": ["listTableRecords", "zapier.listTableRecords"], "flags": ["--filters <value> Filter conditions for the query (default: [])", "--sort <object> Sort records by a field", "--page-size <number> Number of records per page (max 1000)", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--key-mode <string> How to interpret field keys in record data. \"names\"", "--trash <string> Control soft-deleted item visibility. \"exclude\"", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table"], "examples": ["zapier-sdk list-table-records [options] [table]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "get-table-record"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "listTableRecords", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.listTableRecords`. CLI: `zapier-sdk list-table-records [options] [table]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-tables", "kind": "sdk_function", "key": "list-tables", "title": "zapier-sdk list-tables / zapier.listTables", "summary": "List tables available to the authenticated user", "body": "# `list-tables`\n\n> List tables available to the authenticated user\n\n## High-level description\n\nList tables available to the authenticated user\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.listTables`. CLI: `zapier-sdk list-tables [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-tables [options]\n// TS: const { data } = await zapier.listTables({ ... })\n```\n```ts\ntype Input = {\n tables?: string | boolean; // --tables <value> (default: [])\n kind?: string | boolean; // --kind <string> Filter by table type\n search?: string | boolean; // --search <string> Search term to filter tables by name\n owner?: string | boolean; // --owner <string> Filter by table owner. Use \"me\" for the current user,\n include_shared?: string | boolean; // --include-shared Include tables shared with you. Without this, only your\n page_size?: string | boolean; // --page-size <number> Number of tables per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk list-tables [options]`\n- TypeScript: `zapier.listTables(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listTables()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-tables [options]\n\nList tables available to the authenticated user\n\nOptions:\n --tables <value> (default: [])\n --kind <string> Filter by table type\n --search <string> Search term to filter tables by name\n --owner <string> Filter by table owner. Use \"me\" for the current user,\n or a numeric user ID. Requires includeShared to be\n true.\n --include-shared Include tables shared with you. Without this, only your\n own tables are returned.\n --page-size <number> Number of tables per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-tables [options]\n```", "usage": "zapier-sdk list-tables [options]", "signature": "zapier.listTables()", "aliases": ["listTables", "zapier.listTables"], "flags": ["--tables <value> (default: [])", "--kind <string> Filter by table type", "--search <string> Search term to filter tables by name", "--owner <string> Filter by table owner. Use \"me\" for the current user,", "--include-shared Include tables shared with you. Without this, only your", "--page-size <number> Number of tables per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk list-tables [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "get-table-record"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "listTables", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.listTables`. CLI: `zapier-sdk list-tables [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:update-table-records", "kind": "sdk_function", "key": "update-table-records", "title": "zapier-sdk update-table-records / zapier.updateTableRecords", "summary": "Update one or more records in a table", "body": "# `update-table-records`\n\n> Update one or more records in a table\n\n## High-level description\n\nUpdate one or more records in a table\n\n## Internals\n\nZapier Tables CRUD (not partner apps). TypeScript method: `zapier.updateTableRecords`. CLI: `zapier-sdk update-table-records [options] [table] [records]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk update-table-records [options] [table] [records]\n// TS: const { data } = await zapier.updateTableRecords({ ... })\n```\n```ts\ntype Input = {\n table?: string; // table The unique identifier of the table\n records?: string; // records Array of records to update (max 100)\n key_mode?: string | boolean; // --key-mode <string> How to interpret field keys in record data. \"names\"\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Tables)\n\n- Usage: `zapier-sdk update-table-records [options] [table] [records]`\n- TypeScript: `zapier.updateTableRecords(...)`\n\n## Related functions\n\n- `create-table`\n- `create-table-fields`\n- `create-table-records`\n- `delete-table`\n- `delete-table-fields`\n- `delete-table-records`\n- `get-table`\n- `get-table-record`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.updateTableRecords()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk update-table-records [options] [table] [records]\n\nUpdate one or more records in a table\n\nArguments:\n table The unique identifier of the table\n records Array of records to update (max 100)\n\nOptions:\n --key-mode <string> How to interpret field keys in record data. \"names\"\n (default) uses human-readable field names, \"ids\" uses\n raw field IDs (f1, f2). (default: \"names\")\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n### HTTP Requests\n\n## Examples\n\n```bash\nzapier-sdk update-table-records [options] [table] [records]\n```", "usage": "zapier-sdk update-table-records [options] [table] [records]", "signature": "zapier.updateTableRecords()", "aliases": ["updateTableRecords", "zapier.updateTableRecords"], "flags": ["--key-mode <string> How to interpret field keys in record data. \"names\"", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["table The unique identifier of the table", "records Array of records to update (max 100)"], "examples": ["zapier-sdk update-table-records [options] [table] [records]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "tables"], "related": ["create-table", "create-table-fields", "create-table-records", "delete-table", "delete-table-fields", "delete-table-records", "get-table", "get-table-record"], "meta": {"surface": "sdk", "category": "Tables", "typescript": "updateTableRecords", "experimental": false, "mcp_twin": null, "internals": "Zapier Tables CRUD (not partner apps). TypeScript method: `zapier.updateTableRecords`. CLI: `zapier-sdk update-table-records [options] [table] [records]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:curl", "kind": "sdk_function", "key": "curl", "title": "zapier-sdk curl / zapier.curl", "summary": "Make authenticated HTTP requests to any API through Zapier. Pass a connection", "body": "# `curl`\n\n> Make authenticated HTTP requests to any API through Zapier. Pass a connection\n\n## High-level description\n\nMake authenticated HTTP requests to any API through Zapier. Pass a connection\n\n## Internals\n\nAuthenticated raw HTTP through a connection (SDK fetch / curl). TypeScript method: `zapier.curl`. CLI: `zapier-sdk curl [options] <url>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk curl [options] <url>\n// TS: const { data } = await zapier.curl({ ... })\n```\n```ts\ntype Input = {\n url?: string; // url Request URL\n X,?: string | boolean; // -X, --request <string> HTTP method (defaults to GET, or POST if data is\n H,?: string | boolean; // -H, --header <value> HTTP headers in 'Key: Value' format (repeatable)\n d,?: string | boolean; // -d, --data <value> HTTP POST data (repeatable, joined with &)\n data_raw?: string | boolean; // --data-raw <value> HTTP POST data without special interpretation\n data_ascii?: string | boolean; // --data-ascii <value> HTTP POST ASCII data (repeatable) (default: [])\n data_binary?: string | boolean; // --data-binary <value> HTTP POST binary data (repeatable) (default: [])\n data_urlencode?: string | boolean; // --data-urlencode <value> HTTP POST data, URL-encoded (repeatable) (default:\n json?: string | boolean; // --json <string> Send JSON body (sets Content-Type and Accept\n F,?: string | boolean; // -F, --form <value> Multipart form data as 'name=value' (repeatable)\n form_string?: string | boolean; // --form-string <value> Multipart form string field (repeatable) (default:\n G,?: string | boolean; // -G, --get Force GET method and append data to query string\n I,?: string | boolean; // -I, --head Fetch headers only (HEAD request)\n L,?: string | boolean; // -L, --location Follow redirects\n i,?: string | boolean; // -i, --include Include response headers in output\n o,?: string | boolean; // -o, --output <string> Write output to file instead of stdout\n O,?: string | boolean; // -O, --remote-name Write output to file named like the remote file\n v,?: string | boolean; // -v, --verbose Verbose output (show request/response headers on\n s,?: string | boolean; // -s, --silent Silent mode (suppress errors)\n S,?: string | boolean; // -S, --show-error Show errors even when in silent mode\n f,?: string | boolean; // -f, --fail Fail silently on HTTP errors (exit code 22)\n fail_with_body?: string | boolean; // --fail-with-body Fail on HTTP errors but still output the body\n w,?: string | boolean; // -w, --write-out <string> Output format string after completion (e.g.,\n m,?: string | boolean; // -m, --max-time <number> Maximum seconds to wait for a response. Honored on\n u,?: string | boolean; // -u, --user <string> Basic auth credentials as 'user:password'\n compressed?: string | boolean; // --compressed Request compressed response (sends Accept-Encoding\n connection?: string | boolean; // --connection <string> Zapier connection ID or alias for authentication\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (HTTP Requests)\n\n- Usage: `zapier-sdk curl [options] <url>`\n- TypeScript: `zapier.curl(...)`\n\n## Related functions\n\n- _(see same category)_\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.curl()`\n- **MCP:** `write_code_action / z.request analog`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk curl [options] <url>\n\nMake authenticated HTTP requests to any API through Zapier. Pass a connection\nID to automatically inject the user's stored credentials (OAuth tokens, API\nkeys, etc.) into the outgoing request. Use it in place of the native curl\ncommand with additional Zapier-specific options.\n\nArguments:\n url Request URL\n\nOptions:\n -X, --request <string> HTTP method (defaults to GET, or POST if data is\n provided)\n -H, --header <value> HTTP headers in 'Key: Value' format (repeatable)\n (default: [])\n -d, --data <value> HTTP POST data (repeatable, joined with &)\n (default: [])\n --data-raw <value> HTTP POST data without special interpretation\n (repeatable) (default: [])\n --data-ascii <value> HTTP POST ASCII data (repeatable) (default: [])\n --data-binary <value> HTTP POST binary data (repeatable) (default: [])\n --data-urlencode <value> HTTP POST data, URL-encoded (repeatable) (default:\n [])\n --json <string> Send JSON body (sets Content-Type and Accept\n headers)\n -F, --form <value> Multipart form data as 'name=value' (repeatable)\n (default: [])\n --form-string <value> Multipart form string field (repeatable) (default:\n [])\n -G, --get Force GET method and append data to query string\n -I, --head Fetch headers only (HEAD request)\n -L, --location Follow redirects\n -i, --include Include response headers in output\n -o, --output <string> Write output to file instead of stdout\n -O, --remote-name Write output to file named like the remote file\n -v, --verbose Verbose output (show request/response headers on\n stderr)\n -s, --silent Silent mode (suppress errors)\n -S, --show-error Show errors even when in silent mode\n -f, --fail Fail silently on HTTP errors (exit code 22)\n --fail-with-body Fail on HTTP errors but still output the body\n -w, --write-out <string> Output format string after completion (e.g.,\n '%{http_code}')\n -m, --max-time <number> Maximum seconds to wait for a response. Honored on\n a best-effort basis; the server may silently\n enforce a lower ceiling.\n -u, --user <string> Basic auth credentials as 'user:password'\n --compressed Request compressed response (sends Accept-Encoding\n header)\n --connection <string> Zapier connection ID or alias for authentication\n -h, --help Display help for command\n```\n\n### Code Workflows\n\n## Examples\n\n```bash\nzapier-sdk curl [options] <url>\n```", "usage": "zapier-sdk curl [options] <url>", "signature": "zapier.curl()", "aliases": ["curl", "zapier.curl"], "flags": ["-X, --request <string> HTTP method (defaults to GET, or POST if data is", "-H, --header <value> HTTP headers in 'Key: Value' format (repeatable)", "-d, --data <value> HTTP POST data (repeatable, joined with &)", "--data-raw <value> HTTP POST data without special interpretation", "--data-ascii <value> HTTP POST ASCII data (repeatable) (default: [])", "--data-binary <value> HTTP POST binary data (repeatable) (default: [])", "--data-urlencode <value> HTTP POST data, URL-encoded (repeatable) (default:", "--json <string> Send JSON body (sets Content-Type and Accept", "-F, --form <value> Multipart form data as 'name=value' (repeatable)", "--form-string <value> Multipart form string field (repeatable) (default:", "-G, --get Force GET method and append data to query string", "-I, --head Fetch headers only (HEAD request)", "-L, --location Follow redirects", "-i, --include Include response headers in output", "-o, --output <string> Write output to file instead of stdout", "-O, --remote-name Write output to file named like the remote file", "-v, --verbose Verbose output (show request/response headers on", "-s, --silent Silent mode (suppress errors)", "-S, --show-error Show errors even when in silent mode", "-f, --fail Fail silently on HTTP errors (exit code 22)", "--fail-with-body Fail on HTTP errors but still output the body", "-w, --write-out <string> Output format string after completion (e.g.,", "-m, --max-time <number> Maximum seconds to wait for a response. Honored on", "-u, --user <string> Basic auth credentials as 'user:password'", "--compressed Request compressed response (sends Accept-Encoding", "--connection <string> Zapier connection ID or alias for authentication", "-h, --help Display help for command"], "args": ["url Request URL"], "examples": ["zapier-sdk curl [options] <url>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "http-requests"], "related": [], "meta": {"surface": "sdk", "category": "HTTP Requests", "typescript": "curl", "experimental": false, "mcp_twin": "write_code_action / z.request analog", "internals": "Authenticated raw HTTP through a connection (SDK fetch / curl). TypeScript method: `zapier.curl`. CLI: `zapier-sdk curl [options] <url>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:cancel-durable-run", "kind": "sdk_function", "key": "cancel-durable-run", "title": "zapier-sdk cancel-durable-run / zapier.cancelDurableRun", "summary": "Cancel a run-once durable run in initialized or started status. Returns 409 if", "body": "# `cancel-durable-run`\n\n> Cancel a run-once durable run in initialized or started status. Returns 409 if\n\n## High-level description\n\nCancel a run-once durable run in initialized or started status. Returns 409 if\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.cancelDurableRun`. CLI: `zapier-sdk cancel-durable-run [options] [run]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk cancel-durable-run [options] [run]\n// TS: const { data } = await zapier.cancelDurableRun({ ... })\n```\n```ts\ntype Input = {\n run?: string; // run Durable run ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk cancel-durable-run [options] [run]`\n- TypeScript: `zapier.cancelDurableRun(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.cancelDurableRun()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk cancel-durable-run [options] [run]\n\nCancel a run-once durable run in initialized or started status. Returns 409 if\nthe run is already terminal. (experimental)\n\nArguments:\n run Durable run ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk cancel-durable-run [options] [run]\n```", "usage": "zapier-sdk cancel-durable-run [options] [run]", "signature": "zapier.cancelDurableRun()", "aliases": ["cancelDurableRun", "zapier.cancelDurableRun"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["run Durable run ID"], "examples": ["zapier-sdk cancel-durable-run [options] [run]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "cancelDurableRun", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.cancelDurableRun`. CLI: `zapier-sdk cancel-durable-run [options] [run]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:create-workflow", "kind": "sdk_function", "key": "create-workflow", "title": "zapier-sdk create-workflow / zapier.createWorkflow", "summary": "Create a durable workflow container. Starts disabled with no version; publish a", "body": "# `create-workflow`\n\n> Create a durable workflow container. Starts disabled with no version; publish a\n\n## High-level description\n\nCreate a durable workflow container. Starts disabled with no version; publish a\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.createWorkflow`. CLI: `zapier-sdk create-workflow [options] <name>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk create-workflow [options] <name>\n// TS: const { data } = await zapier.createWorkflow({ ... })\n```\n```ts\ntype Input = {\n name?: string; // name Workflow name\n description?: string | boolean; // --description <string> Optional description for the workflow\n private?: string | boolean; // --private If true, only the creating user can see or manage\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk create-workflow [options] <name>`\n- TypeScript: `zapier.createWorkflow(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.createWorkflow()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk create-workflow [options] <name>\n\nCreate a durable workflow container. Starts disabled with no version; publish a\nversion to add code. (experimental)\n\nArguments:\n name Workflow name\n\nOptions:\n --description <string> Optional description for the workflow\n --private If true, only the creating user can see or manage\n this workflow. Defaults to false (account-visible).\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk create-workflow [options] <name>\n```", "usage": "zapier-sdk create-workflow [options] <name>", "signature": "zapier.createWorkflow()", "aliases": ["createWorkflow", "zapier.createWorkflow"], "flags": ["--description <string> Optional description for the workflow", "--private If true, only the creating user can see or manage", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["name Workflow name"], "examples": ["zapier-sdk create-workflow [options] <name>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "createWorkflow", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.createWorkflow`. CLI: `zapier-sdk create-workflow [options] <name>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:delete-workflow", "kind": "sdk_function", "key": "delete-workflow", "title": "zapier-sdk delete-workflow / zapier.deleteWorkflow", "summary": "Delete a durable workflow. Throws `ZapierNotFoundError` if the workflow doesn't", "body": "# `delete-workflow`\n\n> Delete a durable workflow. Throws `ZapierNotFoundError` if the workflow doesn't\n\n## High-level description\n\nDelete a durable workflow. Throws `ZapierNotFoundError` if the workflow doesn't\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.deleteWorkflow`. CLI: `zapier-sdk delete-workflow [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk delete-workflow [options] [workflow]\n// TS: const { data } = await zapier.deleteWorkflow({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk delete-workflow [options] [workflow]`\n- TypeScript: `zapier.deleteWorkflow(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.deleteWorkflow()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk delete-workflow [options] [workflow]\n\nDelete a durable workflow. Throws `ZapierNotFoundError` if the workflow doesn't\nexist; callers wanting idempotency should catch that themselves. (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk delete-workflow [options] [workflow]\n```", "usage": "zapier-sdk delete-workflow [options] [workflow]", "signature": "zapier.deleteWorkflow()", "aliases": ["deleteWorkflow", "zapier.deleteWorkflow"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk delete-workflow [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "deleteWorkflow", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.deleteWorkflow`. CLI: `zapier-sdk delete-workflow [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:disable-workflow", "kind": "sdk_function", "key": "disable-workflow", "title": "zapier-sdk disable-workflow / zapier.disableWorkflow", "summary": "Disable a durable workflow so it stops accepting triggers (experimental)", "body": "# `disable-workflow`\n\n> Disable a durable workflow so it stops accepting triggers (experimental)\n\n## High-level description\n\nDisable a durable workflow so it stops accepting triggers (experimental)\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.disableWorkflow`. CLI: `zapier-sdk disable-workflow [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk disable-workflow [options] [workflow]\n// TS: const { data } = await zapier.disableWorkflow({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk disable-workflow [options] [workflow]`\n- TypeScript: `zapier.disableWorkflow(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.disableWorkflow()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk disable-workflow [options] [workflow]\n\nDisable a durable workflow so it stops accepting triggers (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk disable-workflow [options] [workflow]\n```", "usage": "zapier-sdk disable-workflow [options] [workflow]", "signature": "zapier.disableWorkflow()", "aliases": ["disableWorkflow", "zapier.disableWorkflow"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk disable-workflow [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "disableWorkflow", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.disableWorkflow`. CLI: `zapier-sdk disable-workflow [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:enable-workflow", "kind": "sdk_function", "key": "enable-workflow", "title": "zapier-sdk enable-workflow / zapier.enableWorkflow", "summary": "Enable a durable workflow so it accepts triggers (experimental)", "body": "# `enable-workflow`\n\n> Enable a durable workflow so it accepts triggers (experimental)\n\n## High-level description\n\nEnable a durable workflow so it accepts triggers (experimental)\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.enableWorkflow`. CLI: `zapier-sdk enable-workflow [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk enable-workflow [options] [workflow]\n// TS: const { data } = await zapier.enableWorkflow({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk enable-workflow [options] [workflow]`\n- TypeScript: `zapier.enableWorkflow(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.enableWorkflow()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk enable-workflow [options] [workflow]\n\nEnable a durable workflow so it accepts triggers (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk enable-workflow [options] [workflow]\n```", "usage": "zapier-sdk enable-workflow [options] [workflow]", "signature": "zapier.enableWorkflow()", "aliases": ["enableWorkflow", "zapier.enableWorkflow"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk enable-workflow [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "get-durable-run", "get-trigger-run", "get-workflow", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "enableWorkflow", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.enableWorkflow`. CLI: `zapier-sdk enable-workflow [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-durable-run", "kind": "sdk_function", "key": "get-durable-run", "title": "zapier-sdk get-durable-run / zapier.getDurableRun", "summary": "Get the full state of a run-once durable run, including its operations journal", "body": "# `get-durable-run`\n\n> Get the full state of a run-once durable run, including its operations journal\n\n## High-level description\n\nGet the full state of a run-once durable run, including its operations journal\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getDurableRun`. CLI: `zapier-sdk get-durable-run [options] [run]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-durable-run [options] [run]\n// TS: const { data } = await zapier.getDurableRun({ ... })\n```\n```ts\ntype Input = {\n run?: string; // run Durable run ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk get-durable-run [options] [run]`\n- TypeScript: `zapier.getDurableRun(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-trigger-run`\n- `get-workflow`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getDurableRun()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk get-durable-run [options] [run]\n\nGet the full state of a run-once durable run, including its operations journal\n(experimental)\n\nArguments:\n run Durable run ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-durable-run [options] [run]\n```", "usage": "zapier-sdk get-durable-run [options] [run]", "signature": "zapier.getDurableRun()", "aliases": ["getDurableRun", "zapier.getDurableRun"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["run Durable run ID"], "examples": ["zapier-sdk get-durable-run [options] [run]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-trigger-run", "get-workflow", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "getDurableRun", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getDurableRun`. CLI: `zapier-sdk get-durable-run [options] [run]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-trigger-run", "kind": "sdk_function", "key": "get-trigger-run", "title": "zapier-sdk get-trigger-run / zapier.getTriggerRun", "summary": "Get the workflow run associated with a deployed workflow's trigger. Useful", "body": "# `get-trigger-run`\n\n> Get the workflow run associated with a deployed workflow's trigger. Useful\n\n## High-level description\n\nGet the workflow run associated with a deployed workflow's trigger. Useful\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getTriggerRun`. CLI: `zapier-sdk get-trigger-run [options] <trigger>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-trigger-run [options] <trigger>\n// TS: const { data } = await zapier.getTriggerRun({ ... })\n```\n```ts\ntype Input = {\n trigger?: string; // trigger Workflow trigger ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk get-trigger-run [options] <trigger>`\n- TypeScript: `zapier.getTriggerRun(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-workflow`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getTriggerRun()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk get-trigger-run [options] <trigger>\n\nGet the workflow run associated with a deployed workflow's trigger. Useful\nimmediately after firing a trigger, when you have the trigger ID but not yet\nthe run ID. (experimental)\n\nArguments:\n trigger Workflow trigger ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-trigger-run [options] <trigger>\n```", "usage": "zapier-sdk get-trigger-run [options] <trigger>", "signature": "zapier.getTriggerRun()", "aliases": ["getTriggerRun", "zapier.getTriggerRun"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["trigger Workflow trigger ID"], "examples": ["zapier-sdk get-trigger-run [options] <trigger>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-workflow", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "getTriggerRun", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getTriggerRun`. CLI: `zapier-sdk get-trigger-run [options] <trigger>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-workflow", "kind": "sdk_function", "key": "get-workflow", "title": "zapier-sdk get-workflow / zapier.getWorkflow", "summary": "Get a durable workflow with its current version details and trigger claim", "body": "# `get-workflow`\n\n> Get a durable workflow with its current version details and trigger claim\n\n## High-level description\n\nGet a durable workflow with its current version details and trigger claim\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getWorkflow`. CLI: `zapier-sdk get-workflow [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-workflow [options] [workflow]\n// TS: const { data } = await zapier.getWorkflow({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk get-workflow [options] [workflow]`\n- TypeScript: `zapier.getWorkflow(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow-run`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getWorkflow()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk get-workflow [options] [workflow]\n\nGet a durable workflow with its current version details and trigger claim\nstatus (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-workflow [options] [workflow]\n```", "usage": "zapier-sdk get-workflow [options] [workflow]", "signature": "zapier.getWorkflow()", "aliases": ["getWorkflow", "zapier.getWorkflow"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk get-workflow [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow-run"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "getWorkflow", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getWorkflow`. CLI: `zapier-sdk get-workflow [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-workflow-run", "kind": "sdk_function", "key": "get-workflow-run", "title": "zapier-sdk get-workflow-run / zapier.getWorkflowRun", "summary": "Get the current state of a workflow run (a triggered execution of a deployed", "body": "# `get-workflow-run`\n\n> Get the current state of a workflow run (a triggered execution of a deployed\n\n## High-level description\n\nGet the current state of a workflow run (a triggered execution of a deployed\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getWorkflowRun`. CLI: `zapier-sdk get-workflow-run [options] [run]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-workflow-run [options] [run]\n// TS: const { data } = await zapier.getWorkflowRun({ ... })\n```\n```ts\ntype Input = {\n run?: string; // run Workflow run ID\n workflow?: string | boolean; // --workflow <string> Parent workflow ID — used only to scope the CLI run-id\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk get-workflow-run [options] [run]`\n- TypeScript: `zapier.getWorkflowRun(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getWorkflowRun()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk get-workflow-run [options] [run]\n\nGet the current state of a workflow run (a triggered execution of a deployed\nworkflow) (experimental)\n\nArguments:\n run Workflow run ID\n\nOptions:\n --workflow <string> Parent workflow ID — used only to scope the CLI run-id\n picker; ignored by the API call.\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-workflow-run [options] [run]\n```", "usage": "zapier-sdk get-workflow-run [options] [run]", "signature": "zapier.getWorkflowRun()", "aliases": ["getWorkflowRun", "zapier.getWorkflowRun"], "flags": ["--workflow <string> Parent workflow ID — used only to scope the CLI run-id", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["run Workflow run ID"], "examples": ["zapier-sdk get-workflow-run [options] [run]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "getWorkflowRun", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getWorkflowRun`. CLI: `zapier-sdk get-workflow-run [options] [run]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-workflow-version", "kind": "sdk_function", "key": "get-workflow-version", "title": "zapier-sdk get-workflow-version / zapier.getWorkflowVersion", "summary": "Get full details of a workflow version including source files (experimental)", "body": "# `get-workflow-version`\n\n> Get full details of a workflow version including source files (experimental)\n\n## High-level description\n\nGet full details of a workflow version including source files (experimental)\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getWorkflowVersion`. CLI: `zapier-sdk get-workflow-version [options] [workflow] [version]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-workflow-version [options] [workflow] [version]\n// TS: const { data } = await zapier.getWorkflowVersion({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n version?: string; // version Workflow version ID\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk get-workflow-version [options] [workflow] [version]`\n- TypeScript: `zapier.getWorkflowVersion(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getWorkflowVersion()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk get-workflow-version [options] [workflow] [version]\n\nGet full details of a workflow version including source files (experimental)\n\nArguments:\n workflow Durable workflow ID\n version Workflow version ID\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-workflow-version [options] [workflow] [version]\n```", "usage": "zapier-sdk get-workflow-version [options] [workflow] [version]", "signature": "zapier.getWorkflowVersion()", "aliases": ["getWorkflowVersion", "zapier.getWorkflowVersion"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID", "version Workflow version ID"], "examples": ["zapier-sdk get-workflow-version [options] [workflow] [version]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "getWorkflowVersion", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.getWorkflowVersion`. CLI: `zapier-sdk get-workflow-version [options] [workflow] [version]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-durable-runs", "kind": "sdk_function", "key": "list-durable-runs", "title": "zapier-sdk list-durable-runs / zapier.listDurableRuns", "summary": "List run-once durable runs for the authenticated account, newest first", "body": "# `list-durable-runs`\n\n> List run-once durable runs for the authenticated account, newest first\n\n## High-level description\n\nList run-once durable runs for the authenticated account, newest first\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listDurableRuns`. CLI: `zapier-sdk list-durable-runs [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-durable-runs [options]\n// TS: const { data } = await zapier.listDurableRuns({ ... })\n```\n```ts\ntype Input = {\n page_size?: string | boolean; // --page-size <number> Number of runs per page (max 100)\n cursor?: string | boolean; // --cursor <string> Pagination cursor\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk list-durable-runs [options]`\n- TypeScript: `zapier.listDurableRuns(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listDurableRuns()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk list-durable-runs [options]\n\nList run-once durable runs for the authenticated account, newest first\n(experimental)\n\nOptions:\n --page-size <number> Number of runs per page (max 100)\n --cursor <string> Pagination cursor\n --max-items <number> Maximum total items to return across all pages\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-durable-runs [options]\n```", "usage": "zapier-sdk list-durable-runs [options]", "signature": "zapier.listDurableRuns()", "aliases": ["listDurableRuns", "zapier.listDurableRuns"], "flags": ["--page-size <number> Number of runs per page (max 100)", "--cursor <string> Pagination cursor", "--max-items <number> Maximum total items to return across all pages", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk list-durable-runs [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "listDurableRuns", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listDurableRuns`. CLI: `zapier-sdk list-durable-runs [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-workflow-runs", "kind": "sdk_function", "key": "list-workflow-runs", "title": "zapier-sdk list-workflow-runs / zapier.listWorkflowRuns", "summary": "List workflow runs (triggered executions) for a specific deployed workflow,", "body": "# `list-workflow-runs`\n\n> List workflow runs (triggered executions) for a specific deployed workflow,\n\n## High-level description\n\nList workflow runs (triggered executions) for a specific deployed workflow,\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listWorkflowRuns`. CLI: `zapier-sdk list-workflow-runs [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-workflow-runs [options] [workflow]\n// TS: const { data } = await zapier.listWorkflowRuns({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n page_size?: string | boolean; // --page-size <number> Number of runs per page (max 100)\n cursor?: string | boolean; // --cursor <string> Pagination cursor\n max_items?: string | boolean; // --max-items <number> Maximum total runs to return across all pages\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk list-workflow-runs [options] [workflow]`\n- TypeScript: `zapier.listWorkflowRuns(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listWorkflowRuns()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk list-workflow-runs [options] [workflow]\n\nList workflow runs (triggered executions) for a specific deployed workflow,\nnewest first (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --page-size <number> Number of runs per page (max 100)\n --cursor <string> Pagination cursor\n --max-items <number> Maximum total runs to return across all pages\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-workflow-runs [options] [workflow]\n```", "usage": "zapier-sdk list-workflow-runs [options] [workflow]", "signature": "zapier.listWorkflowRuns()", "aliases": ["listWorkflowRuns", "zapier.listWorkflowRuns"], "flags": ["--page-size <number> Number of runs per page (max 100)", "--cursor <string> Pagination cursor", "--max-items <number> Maximum total runs to return across all pages", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk list-workflow-runs [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "listWorkflowRuns", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listWorkflowRuns`. CLI: `zapier-sdk list-workflow-runs [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-workflow-versions", "kind": "sdk_function", "key": "list-workflow-versions", "title": "zapier-sdk list-workflow-versions / zapier.listWorkflowVersions", "summary": "List published versions for a workflow, newest first (experimental)", "body": "# `list-workflow-versions`\n\n> List published versions for a workflow, newest first (experimental)\n\n## High-level description\n\nList published versions for a workflow, newest first (experimental)\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listWorkflowVersions`. CLI: `zapier-sdk list-workflow-versions [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-workflow-versions [options] [workflow]\n// TS: const { data } = await zapier.listWorkflowVersions({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n page_size?: string | boolean; // --page-size <number> Number of versions per page (max 100)\n cursor?: string | boolean; // --cursor <string> Pagination cursor\n max_items?: string | boolean; // --max-items <number> Maximum total versions to return across all pages\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk list-workflow-versions [options] [workflow]`\n- TypeScript: `zapier.listWorkflowVersions(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listWorkflowVersions()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk list-workflow-versions [options] [workflow]\n\nList published versions for a workflow, newest first (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --page-size <number> Number of versions per page (max 100)\n --cursor <string> Pagination cursor\n --max-items <number> Maximum total versions to return across all pages\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-workflow-versions [options] [workflow]\n```", "usage": "zapier-sdk list-workflow-versions [options] [workflow]", "signature": "zapier.listWorkflowVersions()", "aliases": ["listWorkflowVersions", "zapier.listWorkflowVersions"], "flags": ["--page-size <number> Number of versions per page (max 100)", "--cursor <string> Pagination cursor", "--max-items <number> Maximum total versions to return across all pages", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk list-workflow-versions [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "listWorkflowVersions", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listWorkflowVersions`. CLI: `zapier-sdk list-workflow-versions [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-workflows", "kind": "sdk_function", "key": "list-workflows", "title": "zapier-sdk list-workflows / zapier.listWorkflows", "summary": "List all active durable workflows for the authenticated account (experimental)", "body": "# `list-workflows`\n\n> List all active durable workflows for the authenticated account (experimental)\n\n## High-level description\n\nList all active durable workflows for the authenticated account (experimental)\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listWorkflows`. CLI: `zapier-sdk list-workflows [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-workflows [options]\n// TS: const { data } = await zapier.listWorkflows({ ... })\n```\n```ts\ntype Input = {\n page_size?: string | boolean; // --page-size <number> Number of workflows per page (max 100)\n max_items?: string | boolean; // --max-items <number> Maximum total workflows to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from for pagination\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk list-workflows [options]`\n- TypeScript: `zapier.listWorkflows(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listWorkflows()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk list-workflows [options]\n\nList all active durable workflows for the authenticated account (experimental)\n\nOptions:\n --page-size <number> Number of workflows per page (max 100)\n --max-items <number> Maximum total workflows to return across all pages\n --cursor <string> Cursor to start from for pagination\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk list-workflows [options]\n```", "usage": "zapier-sdk list-workflows [options]", "signature": "zapier.listWorkflows()", "aliases": ["listWorkflows", "zapier.listWorkflows"], "flags": ["--page-size <number> Number of workflows per page (max 100)", "--max-items <number> Maximum total workflows to return across all pages", "--cursor <string> Cursor to start from for pagination", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk list-workflows [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "listWorkflows", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.listWorkflows`. CLI: `zapier-sdk list-workflows [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:publish-workflow-version", "kind": "sdk_function", "key": "publish-workflow-version", "title": "zapier-sdk publish-workflow-version / zapier.publishWorkflowVersion", "summary": "Publish a new version of a durable workflow. Enables the workflow by default.", "body": "# `publish-workflow-version`\n\n> Publish a new version of a durable workflow. Enables the workflow by default.\n\n## High-level description\n\nPublish a new version of a durable workflow. Enables the workflow by default.\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.publishWorkflowVersion`. CLI: `zapier-sdk publish-workflow-version [options] [workflow] [source-files]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk publish-workflow-version [options] [workflow] [source-files]\n// TS: const { data } = await zapier.publishWorkflowVersion({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n source-files?: string; // source-files Source files keyed by filename → contents\n dependencies?: string | boolean; // --dependencies <object> Optional npm package dependencies\n zapier_durable_version?: string | boolean; // --zapier-durable-version <string> Exact semver of @zapier/zapier-durable to\n enabled?: string | boolean; // --enabled Enable the workflow after publishing.\n connections?: string | boolean; // --connections <object> Map of connection aliases to Zapier\n app_versions?: string | boolean; // --app-versions <object> Map of app keys to pinned app\n trigger?: string | boolean; // --trigger <object> Trigger configuration. When provided, the\n json?: string | boolean; // --json Output raw JSON instead of formatted\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk publish-workflow-version [options] [workflow] [source-files]`\n- TypeScript: `zapier.publishWorkflowVersion(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.publishWorkflowVersion()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk publish-workflow-version [options] [workflow] [source-files]\n\nPublish a new version of a durable workflow. Enables the workflow by default.\n(experimental)\n\nArguments:\n workflow Durable workflow ID\n source-files Source files keyed by filename → contents\n\nOptions:\n --dependencies <object> Optional npm package dependencies\n --zapier-durable-version <string> Exact semver of @zapier/zapier-durable to\n use (e.g. \"1.2.3\"). Defaults to\n server-configured version if omitted.\n --enabled Enable the workflow after publishing.\n Defaults to true; pass false to publish\n without enabling.\n --connections <object> Map of connection aliases to Zapier\n connections used by the workflow. Pass\n `null` to clear an existing binding.\n --app-versions <object> Map of app keys to pinned app\n implementation/version used by the\n workflow. Pass `null` to clear an existing\n binding.\n --trigger <object> Trigger configuration. When provided, the\n workflow subscribes to a Zapier trigger;\n omit for webhook-only workflows.\n --json Output raw JSON instead of formatted\n results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk publish-workflow-version [options] [workflow] [source-files]\n```", "usage": "zapier-sdk publish-workflow-version [options] [workflow] [source-files]", "signature": "zapier.publishWorkflowVersion()", "aliases": ["publishWorkflowVersion", "zapier.publishWorkflowVersion"], "flags": ["--dependencies <object> Optional npm package dependencies", "--zapier-durable-version <string> Exact semver of @zapier/zapier-durable to", "--enabled Enable the workflow after publishing.", "--connections <object> Map of connection aliases to Zapier", "--app-versions <object> Map of app keys to pinned app", "--trigger <object> Trigger configuration. When provided, the", "--json Output raw JSON instead of formatted", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID", "source-files Source files keyed by filename → contents"], "examples": ["zapier-sdk publish-workflow-version [options] [workflow] [source-files]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "publishWorkflowVersion", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.publishWorkflowVersion`. CLI: `zapier-sdk publish-workflow-version [options] [workflow] [source-files]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:run-durable", "kind": "sdk_function", "key": "run-durable", "title": "zapier-sdk run-durable / zapier.runDurable", "summary": "Run a workflow source file as a run-once durable run on code-substrate-runner", "body": "# `run-durable`\n\n> Run a workflow source file as a run-once durable run on code-substrate-runner\n\n## High-level description\n\nRun a workflow source file as a run-once durable run on code-substrate-runner\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.runDurable`. CLI: `zapier-sdk run-durable [options] <source-files>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk run-durable [options] <source-files>\n// TS: const { data } = await zapier.runDurable({ ... })\n```\n```ts\ntype Input = {\n source-files?: string; // source-files Source files keyed by filename → contents\n input?: string | boolean; // --input <string> Input data passed to the run. Accepts any\n dependencies?: string | boolean; // --dependencies <object> Optional npm package dependencies\n zapier_durable_version?: string | boolean; // --zapier-durable-version <string> Exact semver of @zapier/zapier-durable to\n connections?: string | boolean; // --connections <object> Named connection aliases. Maps each alias\n app_versions?: string | boolean; // --app-versions <object> Pinned app versions. Maps app keys (slugs)\n private?: string | boolean; // --private Only the creating user can see the run\n notifications?: string | boolean; // --notifications <value> Webhook subscribers for run lifecycle\n json?: string | boolean; // --json Output raw JSON instead of formatted\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk run-durable [options] <source-files>`\n- TypeScript: `zapier.runDurable(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.runDurable()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk run-durable [options] <source-files>\n\nRun a workflow source file as a run-once durable run on code-substrate-runner\n(no deployed workflow required). Returns the run ID immediately; poll via\ngetDurableRun for terminal status. (experimental)\n\nArguments:\n source-files Source files keyed by filename → contents\n\nOptions:\n --input <string> Input data passed to the run. Accepts any\n JSON value, or its JSON-string encoding.\n --dependencies <object> Optional npm package dependencies\n --zapier-durable-version <string> Exact semver of @zapier/zapier-durable to\n use (e.g. \"1.2.3\"). Defaults to\n server-configured version if omitted.\n --connections <object> Named connection aliases. Maps each alias\n to an object holding its Zapier connection\n ID, e.g. `{ \"slack\": { \"connectionId\":\n \"123\" } }`.\n --app-versions <object> Pinned app versions. Maps app keys (slugs)\n to implementation names and versions.\n --private Only the creating user can see the run\n (default false)\n --notifications <value> Webhook subscribers for run lifecycle\n events. Each entry specifies a URL and the\n events it subscribes to. (default: [])\n --json Output raw JSON instead of formatted\n results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk run-durable [options] <source-files>\n```", "usage": "zapier-sdk run-durable [options] <source-files>", "signature": "zapier.runDurable()", "aliases": ["runDurable", "zapier.runDurable"], "flags": ["--input <string> Input data passed to the run. Accepts any", "--dependencies <object> Optional npm package dependencies", "--zapier-durable-version <string> Exact semver of @zapier/zapier-durable to", "--connections <object> Named connection aliases. Maps each alias", "--app-versions <object> Pinned app versions. Maps app keys (slugs)", "--private Only the creating user can see the run", "--notifications <value> Webhook subscribers for run lifecycle", "--json Output raw JSON instead of formatted", "-h, --help Display help for command"], "args": ["source-files Source files keyed by filename → contents"], "examples": ["zapier-sdk run-durable [options] <source-files>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "runDurable", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.runDurable`. CLI: `zapier-sdk run-durable [options] <source-files>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:trigger-workflow", "kind": "sdk_function", "key": "trigger-workflow", "title": "zapier-sdk trigger-workflow / zapier.triggerWorkflow", "summary": "Look up a workflow's trigger URL and fire it manually, as the authenticated", "body": "# `trigger-workflow`\n\n> Look up a workflow's trigger URL and fire it manually, as the authenticated\n\n## High-level description\n\nLook up a workflow's trigger URL and fire it manually, as the authenticated\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.triggerWorkflow`. CLI: `zapier-sdk trigger-workflow [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk trigger-workflow [options] [workflow]\n// TS: const { data } = await zapier.triggerWorkflow({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n input?: string | boolean; // --input <string> JSON payload delivered as the trigger body. Accepts any\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk trigger-workflow [options] [workflow]`\n- TypeScript: `zapier.triggerWorkflow(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.triggerWorkflow()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk trigger-workflow [options] [workflow]\n\nLook up a workflow's trigger URL and fire it manually, as the authenticated\naccount. (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --input <string> JSON payload delivered as the trigger body. Accepts any\n JSON value, or its JSON-string encoding. Sent as\n `application/json`; omit to fire with an empty body.\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk trigger-workflow [options] [workflow]\n```", "usage": "zapier-sdk trigger-workflow [options] [workflow]", "signature": "zapier.triggerWorkflow()", "aliases": ["triggerWorkflow", "zapier.triggerWorkflow"], "flags": ["--input <string> JSON payload delivered as the trigger body. Accepts any", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk trigger-workflow [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "triggerWorkflow", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.triggerWorkflow`. CLI: `zapier-sdk trigger-workflow [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:update-workflow", "kind": "sdk_function", "key": "update-workflow", "title": "zapier-sdk update-workflow / zapier.updateWorkflow", "summary": "Update a durable workflow's name and/or description (experimental)", "body": "# `update-workflow`\n\n> Update a durable workflow's name and/or description (experimental)\n\n## High-level description\n\nUpdate a durable workflow's name and/or description (experimental)\n\n## Internals\n\nExperimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.updateWorkflow`. CLI: `zapier-sdk update-workflow [options] [workflow]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk update-workflow [options] [workflow]\n// TS: const { data } = await zapier.updateWorkflow({ ... })\n```\n```ts\ntype Input = {\n workflow?: string; // workflow Durable workflow ID\n name?: string | boolean; // --name <string> New name for the workflow\n description?: string | boolean; // --description <string> New description for the workflow (pass null to clear)\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Code Workflows)\n\n- Usage: `zapier-sdk update-workflow [options] [workflow]`\n- TypeScript: `zapier.updateWorkflow(...)`\n- Experimental: requires `--experimental`\n\n## Related functions\n\n- `cancel-durable-run`\n- `create-workflow`\n- `delete-workflow`\n- `disable-workflow`\n- `enable-workflow`\n- `get-durable-run`\n- `get-trigger-run`\n- `get-workflow`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.updateWorkflow()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n_(requires `--experimental`)_\n\n```\nUsage: zapier-sdk update-workflow [options] [workflow]\n\nUpdate a durable workflow's name and/or description (experimental)\n\nArguments:\n workflow Durable workflow ID\n\nOptions:\n --name <string> New name for the workflow\n --description <string> New description for the workflow (pass null to clear)\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n### Client Credentials\n\n## Examples\n\n```bash\nzapier-sdk update-workflow [options] [workflow]\n```", "usage": "zapier-sdk update-workflow [options] [workflow]", "signature": "zapier.updateWorkflow()", "aliases": ["updateWorkflow", "zapier.updateWorkflow"], "flags": ["--name <string> New name for the workflow", "--description <string> New description for the workflow (pass null to clear)", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["workflow Durable workflow ID"], "examples": ["zapier-sdk update-workflow [options] [workflow]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "code-workflows"], "related": ["cancel-durable-run", "create-workflow", "delete-workflow", "disable-workflow", "enable-workflow", "get-durable-run", "get-trigger-run", "get-workflow"], "meta": {"surface": "sdk", "category": "Code Workflows", "typescript": "updateWorkflow", "experimental": true, "mcp_twin": null, "internals": "Experimental durable workflows on Zapier infrastructure. TypeScript method: `zapier.updateWorkflow`. CLI: `zapier-sdk update-workflow [options] [workflow]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:create-client-credentials", "kind": "sdk_function", "key": "create-client-credentials", "title": "zapier-sdk create-client-credentials / zapier.createClientCredentials", "summary": "Create new client credentials for the authenticated user", "body": "# `create-client-credentials`\n\n> Create new client credentials for the authenticated user\n\n## High-level description\n\nCreate new client credentials for the authenticated user\n\n## Internals\n\nDeploy SDK in CI without a browser login. TypeScript method: `zapier.createClientCredentials`. CLI: `zapier-sdk create-client-credentials [options] [name]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk create-client-credentials [options] [name]\n// TS: const { data } = await zapier.createClientCredentials({ ... })\n```\n```ts\ntype Input = {\n name?: string; // name Human-readable name for the client credentials\n allowed_scopes?: string | boolean; // --allowed-scopes <value> Scopes to allow for these credentials (default: [])\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Client Credentials)\n\n- Usage: `zapier-sdk create-client-credentials [options] [name]`\n- TypeScript: `zapier.createClientCredentials(...)`\n\n## Related functions\n\n- `delete-client-credentials`\n- `list-client-credentials`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.createClientCredentials()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk create-client-credentials [options] [name]\n\nCreate new client credentials for the authenticated user\n\nArguments:\n name Human-readable name for the client credentials\n\nOptions:\n --allowed-scopes <value> Scopes to allow for these credentials (default: [])\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk create-client-credentials [options] [name]\n```", "usage": "zapier-sdk create-client-credentials [options] [name]", "signature": "zapier.createClientCredentials()", "aliases": ["createClientCredentials", "zapier.createClientCredentials"], "flags": ["--allowed-scopes <value> Scopes to allow for these credentials (default: [])", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["name Human-readable name for the client credentials"], "examples": ["zapier-sdk create-client-credentials [options] [name]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "client-credentials"], "related": ["delete-client-credentials", "list-client-credentials"], "meta": {"surface": "sdk", "category": "Client Credentials", "typescript": "createClientCredentials", "experimental": false, "mcp_twin": null, "internals": "Deploy SDK in CI without a browser login. TypeScript method: `zapier.createClientCredentials`. CLI: `zapier-sdk create-client-credentials [options] [name]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:delete-client-credentials", "kind": "sdk_function", "key": "delete-client-credentials", "title": "zapier-sdk delete-client-credentials / zapier.deleteClientCredentials", "summary": "Delete client credentials by client ID", "body": "# `delete-client-credentials`\n\n> Delete client credentials by client ID\n\n## High-level description\n\nDelete client credentials by client ID\n\n## Internals\n\nDeploy SDK in CI without a browser login. TypeScript method: `zapier.deleteClientCredentials`. CLI: `zapier-sdk delete-client-credentials [options] [client-id]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk delete-client-credentials [options] [client-id]\n// TS: const { data } = await zapier.deleteClientCredentials({ ... })\n```\n```ts\ntype Input = {\n client-id?: string; // client-id The client ID of the client credentials to delete\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Client Credentials)\n\n- Usage: `zapier-sdk delete-client-credentials [options] [client-id]`\n- TypeScript: `zapier.deleteClientCredentials(...)`\n\n## Related functions\n\n- `create-client-credentials`\n- `list-client-credentials`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.deleteClientCredentials()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk delete-client-credentials [options] [client-id]\n\nDelete client credentials by client ID\n\nArguments:\n client-id The client ID of the client credentials to delete\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk delete-client-credentials [options] [client-id]\n```", "usage": "zapier-sdk delete-client-credentials [options] [client-id]", "signature": "zapier.deleteClientCredentials()", "aliases": ["deleteClientCredentials", "zapier.deleteClientCredentials"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["client-id The client ID of the client credentials to delete"], "examples": ["zapier-sdk delete-client-credentials [options] [client-id]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "client-credentials"], "related": ["create-client-credentials", "list-client-credentials"], "meta": {"surface": "sdk", "category": "Client Credentials", "typescript": "deleteClientCredentials", "experimental": false, "mcp_twin": null, "internals": "Deploy SDK in CI without a browser login. TypeScript method: `zapier.deleteClientCredentials`. CLI: `zapier-sdk delete-client-credentials [options] [client-id]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:list-client-credentials", "kind": "sdk_function", "key": "list-client-credentials", "title": "zapier-sdk list-client-credentials / zapier.listClientCredentials", "summary": "List client credentials for the authenticated user", "body": "# `list-client-credentials`\n\n> List client credentials for the authenticated user\n\n## High-level description\n\nList client credentials for the authenticated user\n\n## Internals\n\nDeploy SDK in CI without a browser login. TypeScript method: `zapier.listClientCredentials`. CLI: `zapier-sdk list-client-credentials [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk list-client-credentials [options]\n// TS: const { data } = await zapier.listClientCredentials({ ... })\n```\n```ts\ntype Input = {\n page_size?: string | boolean; // --page-size <number> Number of credentials per page\n max_items?: string | boolean; // --max-items <number> Maximum total items to return across all pages\n cursor?: string | boolean; // --cursor <string> Cursor to start from\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Client Credentials)\n\n- Usage: `zapier-sdk list-client-credentials [options]`\n- TypeScript: `zapier.listClientCredentials(...)`\n\n## Related functions\n\n- `create-client-credentials`\n- `delete-client-credentials`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.listClientCredentials()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk list-client-credentials [options]\n\nList client credentials for the authenticated user\n\nOptions:\n --page-size <number> Number of credentials per page\n --max-items <number> Maximum total items to return across all pages\n --cursor <string> Cursor to start from\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n### Utilities\n\n## Examples\n\n```bash\nzapier-sdk list-client-credentials [options]\n```", "usage": "zapier-sdk list-client-credentials [options]", "signature": "zapier.listClientCredentials()", "aliases": ["listClientCredentials", "zapier.listClientCredentials"], "flags": ["--page-size <number> Number of credentials per page", "--max-items <number> Maximum total items to return across all pages", "--cursor <string> Cursor to start from", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk list-client-credentials [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "client-credentials"], "related": ["create-client-credentials", "delete-client-credentials"], "meta": {"surface": "sdk", "category": "Client Credentials", "typescript": "listClientCredentials", "experimental": false, "mcp_twin": null, "internals": "Deploy SDK in CI without a browser login. TypeScript method: `zapier.listClientCredentials`. CLI: `zapier-sdk list-client-credentials [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:add", "kind": "sdk_function", "key": "add", "title": "zapier-sdk add / zapier.add", "summary": "Add apps with manifest locking and TypeScript type generation - updates", "body": "# `add`\n\n> Add apps with manifest locking and TypeScript type generation - updates\n\n## High-level description\n\nAdd apps with manifest locking and TypeScript type generation - updates\n\n## Internals\n\nProject init, type generation, local MCP server for the SDK. TypeScript method: `zapier.add`. CLI: `zapier-sdk add [options] <apps...>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk add [options] <apps...>\n// TS: const { data } = await zapier.add({ ... })\n```\n```ts\ntype Input = {\n apps?: string; // apps One or more app keys to add (e.g., 'slack',\n connections?: string | boolean; // --connections <value> Connection IDs to use for type generation (e.g.,\n config_path?: string | boolean; // --config-path <string> Path to Zapier config file (defaults to '.zapierrc',\n types_output?: string | boolean; // --types-output <string> Directory for TypeScript type files (defaults to\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Utilities)\n\n- Usage: `zapier-sdk add [options] <apps...>`\n- TypeScript: `zapier.add(...)`\n\n## Related functions\n\n- `build-manifest`\n- `feedback`\n- `generate-app-types`\n- `get-login-config-path`\n- `init`\n- `mcp`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.add()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk add [options] <apps...>\n\nAdd apps with manifest locking and TypeScript type generation - updates\n.zapierrc with app versions and generates TypeScript definition files\n\nArguments:\n apps One or more app keys to add (e.g., 'slack',\n 'github', 'trello')\n\nOptions:\n --connections <value> Connection IDs to use for type generation (e.g.,\n ['123', '456']) (default: [])\n --config-path <string> Path to Zapier config file (defaults to '.zapierrc',\n e.g., './custom/.zapierrc')\n --types-output <string> Directory for TypeScript type files (defaults to\n (src/lib/.)/zapier/apps/, e.g.,\n './src/types/zapier/')\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk add [options] <apps...>\n```", "usage": "zapier-sdk add [options] <apps...>", "signature": "zapier.add()", "aliases": ["add", "zapier.add"], "flags": ["--connections <value> Connection IDs to use for type generation (e.g.,", "--config-path <string> Path to Zapier config file (defaults to '.zapierrc',", "--types-output <string> Directory for TypeScript type files (defaults to", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["apps One or more app keys to add (e.g., 'slack',"], "examples": ["zapier-sdk add [options] <apps...>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "utilities"], "related": ["build-manifest", "feedback", "generate-app-types", "get-login-config-path", "init", "mcp"], "meta": {"surface": "sdk", "category": "Utilities", "typescript": "add", "experimental": false, "mcp_twin": null, "internals": "Project init, type generation, local MCP server for the SDK. TypeScript method: `zapier.add`. CLI: `zapier-sdk add [options] <apps...>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:build-manifest", "kind": "sdk_function", "key": "build-manifest", "title": "zapier-sdk build-manifest / zapier.buildManifest", "summary": "Build manifest entries for apps - can optionally write to disk or just return", "body": "# `build-manifest`\n\n> Build manifest entries for apps - can optionally write to disk or just return\n\n## High-level description\n\nBuild manifest entries for apps - can optionally write to disk or just return\n\n## Internals\n\nProject init, type generation, local MCP server for the SDK. TypeScript method: `zapier.buildManifest`. CLI: `zapier-sdk build-manifest [options] <apps...>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk build-manifest [options] <apps...>\n// TS: const { data } = await zapier.buildManifest({ ... })\n```\n```ts\ntype Input = {\n apps?: string; // apps One or more app keys to build manifest entries for\n skip_write?: string | boolean; // --skip-write If true, returns manifest entries without writing to\n config_path?: string | boolean; // --config-path <string> Path to the manifest file. Only used when skipWrite\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Utilities)\n\n- Usage: `zapier-sdk build-manifest [options] <apps...>`\n- TypeScript: `zapier.buildManifest(...)`\n\n## Related functions\n\n- `add`\n- `feedback`\n- `generate-app-types`\n- `get-login-config-path`\n- `init`\n- `mcp`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.buildManifest()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk build-manifest [options] <apps...>\n\nBuild manifest entries for apps - can optionally write to disk or just return\nJSON\n\nArguments:\n apps One or more app keys to build manifest entries for\n (e.g., 'slack', 'github', 'trello')\n\nOptions:\n --skip-write If true, returns manifest entries without writing to\n disk. If false or omitted, writes to the manifest\n file.\n --config-path <string> Path to the manifest file. Only used when skipWrite\n is false or omitted.\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk build-manifest [options] <apps...>\n```", "usage": "zapier-sdk build-manifest [options] <apps...>", "signature": "zapier.buildManifest()", "aliases": ["buildManifest", "zapier.buildManifest"], "flags": ["--skip-write If true, returns manifest entries without writing to", "--config-path <string> Path to the manifest file. Only used when skipWrite", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["apps One or more app keys to build manifest entries for"], "examples": ["zapier-sdk build-manifest [options] <apps...>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "utilities"], "related": ["add", "feedback", "generate-app-types", "get-login-config-path", "init", "mcp"], "meta": {"surface": "sdk", "category": "Utilities", "typescript": "buildManifest", "experimental": false, "mcp_twin": null, "internals": "Project init, type generation, local MCP server for the SDK. TypeScript method: `zapier.buildManifest`. CLI: `zapier-sdk build-manifest [options] <apps...>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:feedback", "kind": "sdk_function", "key": "feedback", "title": "zapier-sdk feedback / zapier.feedback", "summary": "Submit feedback about the Zapier SDK. AI agents: you should proactively call", "body": "# `feedback`\n\n> Submit feedback about the Zapier SDK. AI agents: you should proactively call\n\n## High-level description\n\nSubmit feedback about the Zapier SDK. AI agents: you should proactively call\n\n## Internals\n\nProject init, type generation, local MCP server for the SDK. TypeScript method: `zapier.feedback`. CLI: `zapier-sdk feedback [options] [feedback]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk feedback [options] [feedback]\n// TS: const { data } = await zapier.feedback({ ... })\n```\n```ts\ntype Input = {\n feedback?: string; // feedback Your feedback on the Zapier SDK. Describe what worked well, what\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Utilities)\n\n- Usage: `zapier-sdk feedback [options] [feedback]`\n- TypeScript: `zapier.feedback(...)`\n\n## Related functions\n\n- `add`\n- `build-manifest`\n- `generate-app-types`\n- `get-login-config-path`\n- `init`\n- `mcp`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.feedback()`\n- **MCP:** `send_feedback`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk feedback [options] [feedback]\n\nSubmit feedback about the Zapier SDK. AI agents: you should proactively call\nthis when a user expresses clear satisfaction or frustration with the SDK —\neven without being asked. This helps the team improve the experience for\neveryone.\n\nArguments:\n feedback Your feedback on the Zapier SDK. Describe what worked well, what\n was frustrating, or any suggestions.\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk feedback [options] [feedback]\n```", "usage": "zapier-sdk feedback [options] [feedback]", "signature": "zapier.feedback()", "aliases": ["feedback", "zapier.feedback"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": ["feedback Your feedback on the Zapier SDK. Describe what worked well, what"], "examples": ["zapier-sdk feedback [options] [feedback]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "utilities"], "related": ["add", "build-manifest", "generate-app-types", "get-login-config-path", "init", "mcp"], "meta": {"surface": "sdk", "category": "Utilities", "typescript": "feedback", "experimental": false, "mcp_twin": "send_feedback", "internals": "Project init, type generation, local MCP server for the SDK. TypeScript method: `zapier.feedback`. CLI: `zapier-sdk feedback [options] [feedback]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:generate-app-types", "kind": "sdk_function", "key": "generate-app-types", "title": "zapier-sdk generate-app-types / zapier.generateAppTypes", "summary": "Generate TypeScript type definitions for apps - can optionally write to disk or", "body": "# `generate-app-types`\n\n> Generate TypeScript type definitions for apps - can optionally write to disk or\n\n## High-level description\n\nGenerate TypeScript type definitions for apps - can optionally write to disk or\n\n## Internals\n\nProject init, type generation, local MCP server for the SDK. TypeScript method: `zapier.generateAppTypes`. CLI: `zapier-sdk generate-app-types [options] <apps...>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk generate-app-types [options] <apps...>\n// TS: const { data } = await zapier.generateAppTypes({ ... })\n```\n```ts\ntype Input = {\n apps?: string; // apps One or more app keys to generate types for\n connections?: string | boolean; // --connections <value> Connection IDs to use for type generation\n skip_write?: string | boolean; // --skip-write If true, returns type definitions without\n types_output_directory?: string | boolean; // --types-output-directory <string> Directory for TypeScript type files.\n json?: string | boolean; // --json Output raw JSON instead of formatted\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Utilities)\n\n- Usage: `zapier-sdk generate-app-types [options] <apps...>`\n- TypeScript: `zapier.generateAppTypes(...)`\n\n## Related functions\n\n- `add`\n- `build-manifest`\n- `feedback`\n- `get-login-config-path`\n- `init`\n- `mcp`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.generateAppTypes()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk generate-app-types [options] <apps...>\n\nGenerate TypeScript type definitions for apps - can optionally write to disk or\njust return type strings\n\nArguments:\n apps One or more app keys to generate types for\n (e.g., 'slack', 'github', 'trello')\n\nOptions:\n --connections <value> Connection IDs to use for type generation\n (e.g., ['123', '456']) (default: [])\n --skip-write If true, returns type definitions without\n writing to disk. If false or omitted,\n writes type files.\n --types-output-directory <string> Directory for TypeScript type files.\n Required when skipWrite is false or\n omitted.\n --json Output raw JSON instead of formatted\n results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk generate-app-types [options] <apps...>\n```", "usage": "zapier-sdk generate-app-types [options] <apps...>", "signature": "zapier.generateAppTypes()", "aliases": ["generateAppTypes", "zapier.generateAppTypes"], "flags": ["--connections <value> Connection IDs to use for type generation", "--skip-write If true, returns type definitions without", "--types-output-directory <string> Directory for TypeScript type files.", "--json Output raw JSON instead of formatted", "-h, --help Display help for command"], "args": ["apps One or more app keys to generate types for"], "examples": ["zapier-sdk generate-app-types [options] <apps...>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "utilities"], "related": ["add", "build-manifest", "feedback", "get-login-config-path", "init", "mcp"], "meta": {"surface": "sdk", "category": "Utilities", "typescript": "generateAppTypes", "experimental": false, "mcp_twin": null, "internals": "Project init, type generation, local MCP server for the SDK. TypeScript method: `zapier.generateAppTypes`. CLI: `zapier-sdk generate-app-types [options] <apps...>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:get-login-config-path", "kind": "sdk_function", "key": "get-login-config-path", "title": "zapier-sdk get-login-config-path / zapier.getLoginConfigPath", "summary": "Show the path to the login configuration file", "body": "# `get-login-config-path`\n\n> Show the path to the login configuration file\n\n## High-level description\n\nShow the path to the login configuration file\n\n## Internals\n\nProject init, type generation, local MCP server for the SDK. TypeScript method: `zapier.getLoginConfigPath`. CLI: `zapier-sdk get-login-config-path [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk get-login-config-path [options]\n// TS: const { data } = await zapier.getLoginConfigPath({ ... })\n```\n```ts\ntype Input = {\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Utilities)\n\n- Usage: `zapier-sdk get-login-config-path [options]`\n- TypeScript: `zapier.getLoginConfigPath(...)`\n\n## Related functions\n\n- `add`\n- `build-manifest`\n- `feedback`\n- `generate-app-types`\n- `init`\n- `mcp`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.getLoginConfigPath()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk get-login-config-path [options]\n\nShow the path to the login configuration file\n\nOptions:\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk get-login-config-path [options]\n```", "usage": "zapier-sdk get-login-config-path [options]", "signature": "zapier.getLoginConfigPath()", "aliases": ["getLoginConfigPath", "zapier.getLoginConfigPath"], "flags": ["--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk get-login-config-path [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "utilities"], "related": ["add", "build-manifest", "feedback", "generate-app-types", "init", "mcp"], "meta": {"surface": "sdk", "category": "Utilities", "typescript": "getLoginConfigPath", "experimental": false, "mcp_twin": null, "internals": "Project init, type generation, local MCP server for the SDK. TypeScript method: `zapier.getLoginConfigPath`. CLI: `zapier-sdk get-login-config-path [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:init", "kind": "sdk_function", "key": "init", "title": "zapier-sdk init / zapier.init", "summary": "Create a new Zapier SDK project in a new directory with starter files", "body": "# `init`\n\n> Create a new Zapier SDK project in a new directory with starter files\n\n## High-level description\n\nCreate a new Zapier SDK project in a new directory with starter files\n\n## Internals\n\nProject init, type generation, local MCP server for the SDK. TypeScript method: `zapier.init`. CLI: `zapier-sdk init [options] <project-name>`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk init [options] <project-name>\n// TS: const { data } = await zapier.init({ ... })\n```\n```ts\ntype Input = {\n project-name?: string; // project-name Name of the project directory to create\n non_interactive?: string | boolean; // --non-interactive Skip all interactive prompts and accept all defaults\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Utilities)\n\n- Usage: `zapier-sdk init [options] <project-name>`\n- TypeScript: `zapier.init(...)`\n\n## Related functions\n\n- `add`\n- `build-manifest`\n- `feedback`\n- `generate-app-types`\n- `get-login-config-path`\n- `mcp`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.init()`\n- **MCP:** `—`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk init [options] <project-name>\n\nCreate a new Zapier SDK project in a new directory with starter files\n\nArguments:\n project-name Name of the project directory to create\n\nOptions:\n --non-interactive Skip all interactive prompts and accept all defaults\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk init [options] <project-name>\n```", "usage": "zapier-sdk init [options] <project-name>", "signature": "zapier.init()", "aliases": ["init", "zapier.init"], "flags": ["--non-interactive Skip all interactive prompts and accept all defaults", "-h, --help Display help for command"], "args": ["project-name Name of the project directory to create"], "examples": ["zapier-sdk init [options] <project-name>"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "utilities"], "related": ["add", "build-manifest", "feedback", "generate-app-types", "get-login-config-path", "mcp"], "meta": {"surface": "sdk", "category": "Utilities", "typescript": "init", "experimental": false, "mcp_twin": null, "internals": "Project init, type generation, local MCP server for the SDK. TypeScript method: `zapier.init`. CLI: `zapier-sdk init [options] <project-name>`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "sdk_function:mcp", "kind": "sdk_function", "key": "mcp", "title": "zapier-sdk mcp / zapier.mcp", "summary": "Start MCP server for Zapier SDK", "body": "# `mcp`\n\n> Start MCP server for Zapier SDK\n\n## High-level description\n\nStart MCP server for Zapier SDK\n\n## Internals\n\nProject init, type generation, local MCP server for the SDK. TypeScript method: `zapier.mcp`. CLI: `zapier-sdk mcp [options]`.\n\n## Typed inputs\n\n```ts\n// CLI: zapier-sdk mcp [options]\n// TS: const { data } = await zapier.mcp({ ... })\n```\n```ts\ntype Input = {\n port?: string | boolean; // --port <string> Port to listen on (for future HTTP transport)\n json?: string | boolean; // --json Output raw JSON instead of formatted results\n h,?: string | boolean; // -h, --help Display help for command\n};\n```\n\n## Outputs\n\n```ts\n{ data: T } | paginated { data: T[]; next_cursor?: string }\n// --json for raw. Always prefer live discovery over hardcoded keys.\n```\n\n## Surface: Zapier SDK CLI / TypeScript (Utilities)\n\n- Usage: `zapier-sdk mcp [options]`\n- TypeScript: `zapier.mcp(...)`\n\n## Related functions\n\n- `add`\n- `build-manifest`\n- `feedback`\n- `generate-app-types`\n- `get-login-config-path`\n- `init`\n\n## Twins (MCP / other CLI)\n\n- **TypeScript:** `zapier.mcp()`\n- **MCP:** `hosted Zapier MCP (different server)`\n- **Platform CLI:** `n/a (SDK consumes apps; Platform CLI publishes them)`\n\n## Official text\n\n```\nUsage: zapier-sdk mcp [options]\n\nStart MCP server for Zapier SDK\n\nOptions:\n --port <string> Port to listen on (for future HTTP transport)\n --json Output raw JSON instead of formatted results\n -h, --help Display help for command\n```\n\n## Examples\n\n```bash\nzapier-sdk mcp [options]\n```", "usage": "zapier-sdk mcp [options]", "signature": "zapier.mcp()", "aliases": ["mcp", "zapier.mcp"], "flags": ["--port <string> Port to listen on (for future HTTP transport)", "--json Output raw JSON instead of formatted results", "-h, --help Display help for command"], "args": [], "examples": ["zapier-sdk mcp [options]"], "source_url": "https://docs.zapier.com/sdk/cli-reference", "source_repo": "zapier/sdk", "source_path": "skills/zapier-sdk/references/cli-commands.md", "section": "sdk", "tags": ["sdk", "function", "zapier-sdk", "utilities"], "related": ["add", "build-manifest", "feedback", "generate-app-types", "get-login-config-path", "init"], "meta": {"surface": "sdk", "category": "Utilities", "typescript": "mcp", "experimental": false, "mcp_twin": "hosted Zapier MCP (different server)", "internals": "Project init, type generation, local MCP server for the SDK. TypeScript method: `zapier.mcp`. CLI: `zapier-sdk mcp [options]`."}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
{"_id": "guide:zapier-functions", "kind": "guide", "key": "zapier-functions", "title": "Zapier functions — CLI, core, SDK catalog", "summary": "Complete function reference. Start from build-new-connector, then query cli_function / core_function / sdk_function.", "body": "# Zapier functions — complete reference (CLI, core, SDK)\n\n**Start here first:**\n`db.platform_reference.findOne({ kind: \"guide\", key: \"build-new-connector\" })`\nor [PLATFORM-REFERENCE.md](PLATFORM-REFERENCE.md).\n\nThis guide is the **function catalog**. MCP tools are documented separately as\n`kind: \"mcp_function\"` and [MCP-REFERENCE.md](MCP-REFERENCE.md).\n\n## Surfaces (do not mix)\n\n| Surface | kind | Count | Package |\n|---------|------|------:|---------|\n| Hosted MCP meta-tools | `mcp_function` | 17 | mcp.zapier.com |\n| Platform CLI (publish an integration) | `cli_function` | 40 | `zapier-platform-cli` |\n| Platform core (`z`, perform, middleware) | `core_function` | 32 | `zapier-platform-core` |\n| SDK CLI + TypeScript (consume apps) | `sdk_function` | 78 | `@zapier/zapier-sdk` / `@zapier/zapier-sdk-cli` |\n\n```js\ndb.platform_reference.find({ kind: \"cli_function\" }).sort({ key: 1 })\ndb.platform_reference.find({ kind: \"core_function\" }).sort({ key: 1 })\ndb.platform_reference.find({ kind: \"sdk_function\" }).sort({ key: 1 })\ndb.platform_reference.findOne({ kind: \"sdk_function\", key: \"run-action\" })\ndb.platform_reference.findOne({ kind: \"core_function\", key: \"z.request\" })\n```\n\nHuman index: [FUNCTIONS-REFERENCE.md](FUNCTIONS-REFERENCE.md).\n\n## Build-an-integration call graph\n\n```\nzapier-platform login\n → init --template oauth2\n → scaffold trigger|create|search\n → implement (z, bundle) with z.request / z.errors.*\n → invoke auth start|test / test / validate\n → register → push → promote → migrate\n```\n\n## Consume-an-app call graph (SDK)\n\n```\nzapier-sdk login\n → list-apps → list-actions → list-action-input-fields\n → find-first-connection | create-connection\n → run-action\n (events) list-triggers → create-trigger-inbox → lease/ack\n (raw HTTP) curl --connection <id>\n```\n\nSame methods exist on `createZapierSdk()` as camelCase (`runAction`, `listApps`, …).\n", "usage": "db.platform_reference.findOne({kind:\"guide\", key:\"zapier-functions\"})", "signature": "", "aliases": ["functions playbook"], "flags": [], "args": [], "examples": [], "source_url": "", "source_repo": "", "source_path": "scripts/ingest-function-reference.py", "section": "guide", "tags": ["guide", "functions", "cli", "sdk", "core"], "related": [], "meta": {"cli": 40, "core": 32, "sdk": 78}, "ingested_at": "2026-08-18T00:47:02.915957+00:00"}
Reference in a new issue View git blame Copy permalink