@ever-works/zapier-plugin

中文文档
1.0.18发布于 2026/11/03AGPL-3.0TypeScriptESM + CJS构建来源已验证近 30 天下载 2629

Zapier Automation Pipeline Plugin - Triggers Zapier actions during Work generation

原始使用文档
文档目录10 节
  1. Plugin metadata
  2. What does the Zapier plugin do?
  3. Why use it?
  4. How it works in Ever Works
  5. Getting started
  6. Settings
  7. Troubleshooting
  8. Local development
  9. Documentation
  10. License

@ever-works/zapier-plugin

Zapier Automation Pipeline Plugin - Triggers Zapier actions during Work generation

Plugin metadata

FieldValue
IDzapier
Categorypipeline
Capabilitiespipeline, form-schema-provider
AuthorEver Works Team
LicenseAGPL-3.0
Built-inyes
Auto-enableno

What does the Zapier plugin do?

This plugin lets Ever Works delegate the work-generation pipeline to Zapier, the workflow-automation platform with connectors for thousands of apps. Instead of running the built-in pipeline, Ever Works invokes a Zapier action — through the official Zapier SDK — during each generation request.

You pick any Zapier action (search, create, or fire-and-forget), connect it to one of your Zapier authentications, and the plugin executes that action with the work context payload. Zapier returns the action result, which Ever Works converts into pipeline outputs in one of two shapes: a structured { items: [...] } contract for custom Zaps, or a native-record mode where raw Zapier output is projected onto work items via a configurable field mapping. Side-effect actions (send email, post a message, create a task) are also supported and complete with zero items.

Why use it?

  • Trigger any of Zapier's integrations across thousands of apps without writing connector code.
  • Three execution shapes — structured items, native record with field mapping, or fire-and-forget side effect — to match different use cases.
  • Reuse existing Zapier authentications, app connections, and Zaps you already maintain.
  • Swap in different actions or remap fields without touching Ever Works code.
  • Use long-lived OAuth client credentials in production and short-lived access tokens for local development.

How it works in Ever Works

When this plugin is selected as the active pipeline, the platform invokes a Zapier action through the official @zapier/zapier-sdk, identifying it by appKey, actionType (search/create/etc.), and actionKey, paired with one of your Zapier authentications. The action runs on Zapier's infrastructure and returns its result. Depending on the configured result shape, the plugin either expects a structured { items: [...] } JSON object, projects raw record fields onto work items using your field mapping, or treats the action as a side effect that produces no items. The structured output is parsed back into Ever Works pipeline outputs (the work draft, items list, categories, tags). The required output schema is documented in the Ever Works docs.

Getting started

  1. Sign up at zapier.com and identify the action you want Ever Works to trigger (note its app_key, action_type, and action_key).
  2. In the Zapier UI, connect the authentication you want the action to use and copy its authentication ID.
  3. Run npx zapier-sdk create-client-credentials to mint long-lived Client ID and Client Secret values for production use, or npx zapier-sdk login to obtain a short-lived access token for local development.
  4. Open the Zapier plugin settings in Ever Works and paste either the Client ID + Client Secret or the access token. Save.
  5. In the Generate flow, set the action reference (app_key, action_type, action_key, authentication_id) and the result shape, then trigger a run.

Settings

  • clientId — Long-lived OAuth Client ID from npx zapier-sdk create-client-credentials. Recommended for production.
  • clientSecret (secret) — Long-lived Client Secret paired with clientId. Shown only once during creation.
  • accessToken (secret) — Short-lived bearer token from npx zapier-sdk login. Use for local development only.
  • baseUrl — Override the Zapier SDK base URL (leave empty for the SDK default).

Authentication requires either accessToken or both clientId and clientSecret. The generator form additionally exposes per-run options including the action reference (app key, action type, action key, authentication ID), the result shape (structured / native record / side-effect), the field mapping for native records, and the action timeout.

Troubleshooting

SymptomLikely causeFix
Generation never starts / stays at 0%zapier not selected as the active pipeline plugin for this workOpen the work → Plugins → pipeline capability and set zapier as the active pipeline; or set it as the global pipeline default in Settings → Plugins
Step fails with No AI / search / screenshot provider configuredPipeline depends on capability plugins that are not enabled or have no credentialsEnable and configure the matching capability plugin (AI provider, search, screenshot, content-extractor) for the work or globally
Step output looks wrong / genericForm-field tuning not set; pipeline using defaults that don't match the work's domainOpen the Generator Form for the work, set domain-specific fields (categories, target keywords, source URLs), and re-run the affected step
Webhook returns 404 / Not FoundScenario / Zap not enabled or webhook URL staleIn the Zapier Automation dashboard verify the scenario is active, copy a fresh webhook URL into the plugin settings, and trigger a test run
Pipeline cannot resume after host restartCheckpoint not persisted (only the standard pipeline persists checkpoints today)Cancel the stuck run and re-trigger generation; for production reliability prefer standard-pipeline

Local development

This plugin ships built-in with the Ever Works platform. To work on it locally from the monorepo root:

pnpm install
pnpm --filter @ever-works/zapier-plugin build
pnpm --filter @ever-works/zapier-plugin test

Documentation

License

AGPL-3.0

版本与发布记录

@ever-works/zapier-plugin 共发布 15 个版本,首次发布于 2026/06/06;过去 12 个月发布了 15 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.18latest2026/11/0310 天前
1.0.172026/10/2817 天前
1.0.162026/10/2717 天前
1.0.152026/10/2717 天前
1.0.142026/10/2420 天前
1.0.132026/10/2025 天前

关于 @ever-works/zapier-plugin 的常见问题

@ever-works/zapier-plugin 是什么?

Zapier Automation Pipeline Plugin - Triggers Zapier actions during Work generation

如何安装 @ever-works/zapier-plugin?

在项目目录运行 npm install @ever-works/zapier-plugin,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@ever-works/plugin(^1.2.16)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@ever-works/zapier-plugin 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@ever-works/zapier-plugin 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@ever-works/zapier-plugin 可以商用吗?

@ever-works/zapier-plugin 使用 AGPL-3.0 许可。最严格的 Copyleft:除分发外,通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括,不构成法律意见,请以许可原文为准。

@ever-works/zapier-plugin 的下载量有多少?

根据 npm 官方下载统计,@ever-works/zapier-plugin 在 2026/10/14 – 2026/11/12 这 30 天内被下载 2,629 次,日均约 88 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ever-works/zapier-plugin 还在维护吗?

最新版本 1.0.18 发布于 2026/11/03(10 天前);至今共发布 15 个版本,其中过去 12 个月发布了 15 个;首次发布于 2026/06/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。