# @bigbinary/neeto-webhooks-frontend 中文文档

规范地址：https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/

版本：3\.3\.0
npm 元数据更新时间：2026-11-03T06:53:34.687Z
中文译文更新时间：2026-11-08T02:00:47.613Z
软件包许可：UNLICENSED

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bigbinary/neeto-webhooks-frontend
原文对照：https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/?lang=original
项目主页：https://github.com/bigbinary/neeto-webhooks-nano

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：809 kB，71 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13
- 运行依赖：2 个
- peer 依赖：qs 6\.16\.2，url 0\.11\.4，yup 0\.32\.11，antd 5\.22\.1，util ^0\.12\.5，axios 1\.20\.0，ramda 0\.29\.0，react 18\.3\.1，buffer ^6\.0\.3，formik 2\.4\.6，i18next 22\.5\.1，zustand 4\.4\.2，js-logger 1\.6\.1，react-dom 18\.3\.1，classnames 2\.5\.1，stream-http 3\.2\.0，tailwindcss 3\.4\.14，react-helmet ^6\.1\.0，os-browserify 0\.3\.0，react-i18next 12\.3\.1，vm-browserify 1\.1\.2，@babel/runtime 7\.29\.7，react-toastify 8\.0\.2，tty-browserify 0\.0\.1，path-browserify ^1\.0\.1，https-browserify 1\.0\.0，mixpanel-browser 2\.45\.0，react-router-dom 5\.3\.3，crypto-browserify 3\.12\.1，source-map-loader 4\.0\.1，stream-browserify ^3\.0\.0，@bigbinary/neetoui 8\.8\.3，@honeybadger-io/js 6\.10\.1，@bigbinary/neeto-cist 1\.0\.17，@honeybadger-io/react 6\.1\.25，@tanstack/react-query 5\.59\.20，@bigbinary/neeto-atoms 1\.1\.2，@bigbinary/neeto-icons 1\.20\.89，@bigbinary/neeto-molecules 5\.9\.15，@tailwindcss/container-queries 0\.1\.1，@tanstack/react-query-devtools 5\.59\.20，@bigbinary/neeto-commons-frontend 4\.14\.8，@bigbinary/neeto-filters-frontend 4\.6\.3
- 首次发布：2023-02-02T18:52:06.261Z
- 最新版本发布：2026-11-03T06:53:34.520Z
- 近 30 天下载量：24108（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：121（近 12 个月 35 个）

## 中文简介

管理横跨 neto 产品的 Webhoks.

## 安装

```sh
npm install @bigbinary/neeto-webhooks-frontend
```

也可以使用：`pnpm add @bigbinary/neeto-webhooks-frontend`、`yarn add @bigbinary/neeto-webhooks-frontend`、`bun add @bigbinary/neeto-webhooks-frontend`

## README

# {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}必须去网游 -nano

这个 `neeto-webhooks-nano` 管理 neto 应用程序中的 Webhooks 。 纳米 出口 `@bigbinary/neeto-webhooks-frontend` 国家防范机制一揽子计划 财务报告和审定财务报表 `neeto-webhooks-engine` 铁路发展引擎. 它的网钩 Playwright 帮助器独立发布为 `@bigbinary/neeto-webhooks-playwright` 从 [`playwright/`](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/playwright/README.md) 目录.

# 目录

1.  [用主机应用程序开发](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-development-with-host-application)
    -   [发动机](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-engine)
        -   [安装](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-installation)
        -   [使用量](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-usage)
    -   [前端软件包](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-frontend-package)
        -   [安装](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-installation-1)
        -   [构成部分](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-components)
2.  [出版指令](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/#readme-instructions-for-publishing)
3.  [剧作家助手](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/playwright/README.md)

# 用主机应用程序开发

## 发动机

该引擎被用于管理横跨neto产品的webhooks.

### 安装

1.  将此行添加到您的应用程序的 Gemfile 中 :
    
    ```ruby
    source "NEETO_GEM_SERVER_URL" do
       # ..existing gems
    
       gem 'neeto-webhooks-engine'
    
       # Use this for live development:
       # gem 'neeto-webhooks-engine', path: "../neeto-webhooks-nano"
    end
    ```
    
2.  然后执行:
    
    ```zsh
    bundle install
    ```
    
3.  将此行添加到您的应用程序 `config/routes.rb` 文件 :
    
    ```ruby
    mount NeetoWebhooksEngine::Engine, at: "/neeto_webhooks"
    ```
    
4.  运行以下命令以复制从引擎到主机的迁移 应用程序 :
    
    ```zsh
    rails g neeto_webhooks_engine:install
    ```
    
5.  添加迁移到数据库 :
    
    ```zsh
    bundle exec rails db:migrate
    ```
    
6.  在应用程序中添加下行 配置/ 初始化/ neto webhooks engine. rb 文件. 替换 事件 识别符,其中包含一系列代表可能的唯一关键字 网络事件.
    
    ```zsh
    NeetoWebhooksEngine.event_identifiers = ["create", "update", "cancel"]
    ```
    
7.  使用密钥格式添加 Webhook 事件的翻译 webhook.events.webhook event,其中由自定义的webhook event 事件 标识符.
    
    ```zsh
    webhooks:
      events:
        create: "Booking creation"
        update: "Booking reschedule"
        cancel: "Booking cancellation"
    ```
    
8.  (可选) 配置分类标识符自动注入分类 值为翻译字符串。 然后这些值可以用于语言字符串 作为插值变量.
    
    ```ruby
    NeetoWebhooksEngine.taxonomy_identifiers = {
      customer: "singular",
      teamMember: "singular"
    }
    ```
    
9.  添加权限 `neeto_webhooks_engine.manage_webhooks` 给您的 `permissions.yml` 文档.
    

### 使用量

您可以在此了解更多设置和用途:

1.  [模型](https://npmcn.com/docs/engine/models.md)
2.  [Webhook 版本执行](https://npmcn.com/docs/webhook-versioning.md)

## 前端软件包

### 安装

1.  安装最新的 `neeto-webhooks-nano` 使用下列命令的软件包:
    
    ```zsh
    yarn add @bigbinary/neeto-webhooks-frontend
    ```
    

### 发展指示

检查 [前端软件包开发指南](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) 用于开发前端软件包的分步指令.

### 构成部分

#### `NeetoWebhooks` (单位:千美元)[源代码](https://github.com/bigbinary/neeto-webhooks-nano/blob/52aa6b3fc38dce1afb9f6a7a821f3d2d12cb6a6a/app/javascript/src/components/NeetoWebhooks.jsx)(中文(简体) )

此组件用于管理您的网络应用程序中的 Webhooks .

1.  它为浏览,添加,并编辑webhooks提供了一个用户界面.
2.  它还包括一个用户界面,用于列出交货和取景交货 细节,显示既显示请求信息又显示响应信息的标签.

##### 道具

两者都需要,组件记录一个错误,以名称为准 失踪。 他们失败不同, 值得知道当其中之一是 错误:没有 `entityId` 列表中无法装入, 而不需要 `entityType` 列表仍然会生成,并且只创建一个 webhook 失败 .

-   `entityType`: 拥有这些 Webhoks 的唱片的类名, 和一个 数值 `NeetoWebhooksEngine.valid_entity_types`。通常情况下 `"Organization"`。 。 。 .
-   `entityId`:该记录的ID. 请注意: `globalProps.organization` 已经 不携带 `id` 在大多数需要的应用程序中,它被序列化为名称,子域名, favicon和密钥——所以主机通常需要通过自己的id发送 客户端道具.

##### 可选道具

-   `breadcrumbs`: 指定用于导航的面包屑的一系列物体.
-   `helpLinkUrls`: 指定帮助链接的 URL 对象.
    -   `webhooks`:webhooks的URL帮助链接.
    -   `secrets`: 机密的URL帮助链接.
    -   `deliveries`: 交付的URL帮助链接.

##### 使用量

```jsx
import React from "react";

import { NeetoWebhooks } from "@bigbinary/neeto-webhooks-frontend";
import { routes } from "common/routes";
import { BrowserRouter, Route, Switch } from "react-router-dom";
import { ToastContainer } from "react-toastify";

const Main = () => (
  <BrowserRouter>
    <div className="flex">
      <Switch>
        <Route
          path={routes.webhooks}
          component={() => (
            <NeetoWebhooks
              entityId={entityId}
              entityType={entityType}
              breadcrumbs={[
                {
                  text: "Settings",
                  link: routes.settings,
                },
                { text: "Webhook" },
              ]}
              helpLinkUrls={{
                webhooks:
                  "https://help.neetokb.com/articles/creating-a-webhook",
                secrets:
                  "https://help.neetokb.com/articles/securing-webhook-requests",
                deliveries:
                  "https://help.neetokb.com/articles/managing-webhook-deliveries",
              }}
            />
          )}
        />
      </Switch>
    </div>
    <ToastContainer />
  </BrowserRouter>
);

export default Main;
```

# 出版指令

咨询 [构建和释放软件包](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) 关于如何出版的详细指南.

`@bigbinary/neeto-webhooks-playwright` 与 [`playwright/`](https://npmcn.com/package/%40bigbinary/neeto-webhooks-frontend/playwright/README.md) 当合并后的公关有 `playwright` 标签和a `patch`, (中文(简体) ), `minor`,或 `major` 标签.

## 常见问题

### @bigbinary/neeto-webhooks-frontend 是什么？

管理横跨 neto 产品的 Webhoks\.

### 如何安装 @bigbinary/neeto-webhooks-frontend？

在项目目录运行 npm install @bigbinary/neeto-webhooks-frontend，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：qs（6\.16\.2）、url（0\.11\.4）、yup（0\.32\.11）、antd（5\.22\.1）、util（^0\.12\.5）、axios（1\.20\.0）、ramda（0\.29\.0）、react（18\.3\.1）、buffer（^6\.0\.3）、formik（2\.4\.6）、i18next（22\.5\.1）、zustand（4\.4\.2）、js-logger（1\.6\.1）、react-dom（18\.3\.1）、classnames（2\.5\.1）、stream-http（3\.2\.0）、tailwindcss（3\.4\.14）、react-helmet（^6\.1\.0）、os-browserify（0\.3\.0）、react-i18next（12\.3\.1）、vm-browserify（1\.1\.2）、@babel/runtime（7\.29\.7）、react-toastify（8\.0\.2）、tty-browserify（0\.0\.1）、path-browserify（^1\.0\.1）、https-browserify（1\.0\.0）、mixpanel-browser（2\.45\.0）、react-router-dom（5\.3\.3）、crypto-browserify（3\.12\.1）、source-map-loader（4\.0\.1）、stream-browserify（^3\.0\.0）、@bigbinary/neetoui（8\.8\.3）、@honeybadger-io/js（6\.10\.1）、@bigbinary/neeto-cist（1\.0\.17）、@honeybadger-io/react（6\.1\.25）、@tanstack/react-query（5\.59\.20）、@bigbinary/neeto-atoms（1\.1\.2）、@bigbinary/neeto-icons（1\.20\.89）、@bigbinary/neeto-molecules（5\.9\.15）、@tailwindcss/container-queries（0\.1\.1）、@tanstack/react-query-devtools（5\.59\.20）、@bigbinary/neeto-commons-frontend（4\.14\.8）、@bigbinary/neeto-filters-frontend（4\.6\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bigbinary/neeto-webhooks-frontend 支持 TypeScript 吗？

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

### @bigbinary/neeto-webhooks-frontend 支持 ESM 还是 CommonJS？

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

### @bigbinary/neeto-webhooks-frontend 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.13。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bigbinary/neeto-webhooks-frontend 可以商用吗？

@bigbinary/neeto-webhooks-frontend 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @bigbinary/neeto-webhooks-frontend 的下载量有多少？

根据 npm 官方下载统计，@bigbinary/neeto-webhooks-frontend 在 2026/10/08 – 2026/11/06 这 30 天内被下载 24,108 次，日均约 804 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bigbinary/neeto-webhooks-frontend 还在维护吗？

最新版本 3\.3\.0 发布于 2026/11/03（5 天前）；至今共发布 121 个版本，其中过去 12 个月发布了 35 个；首次发布于 2023/02/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。