Back to Details

catalyst-signals

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Prerequisites

前提条件

Before using Signals, activate it once per project in the console:
Console → your project → Signals (left sidebar) → click "Start Exploring"
Skipping this step prevents access to Publishers, Webhooks, Rules, and Logs. This is a one-time activation per project.
使用Signals之前，需在控制台中为每个项目激活一次：
控制台 → 你的项目 → 左侧边栏的Signals → 点击**「开始探索」**
跳过此步骤将无法访问Publishers、Webhooks、Rules和Logs。每个项目仅需激活一次。

How It Works

工作原理

  1. Console-Only Service — HARD STOP if user expects SDK/API. Catalyst Signals is configured entirely through the Catalyst Console — there is NO SDK, REST API, or programmatic interface for creating publishers, rules, or webhooks. All setup is done via the console UI.
    • Publishers, events, webhooks, and rules are created in Console → Signals
    • Functions and Circuits are created separately in Console → Serverless, then selected as targets in Signals rules
    • The only code-level interaction is receiving events in target functions/circuits
  2. Understand the flow — Publisher → Event → Rule (with filters/transforms) → Target (Webhook/Function/Circuit)
  3. Load 
    references/signals-basics.md
     — for publishers (Zoho/Catalyst/Custom), events, rules, targets, dispatch policies, event statuses, and deployment gotchas
  4. Key concepts:
    • Publishers emit events when actions occur (3 types: Zoho, Catalyst CloudScale, Custom)
    • Events are JSON payloads with auto-generated schemas (max 100KB for Zoho, 64KB for Custom)
    • Rules connect publishers to targets with optional filters and payload transformations
    • Targets receive events via Webhooks, Functions, or Circuits
    • Dispatch Policy controls event delivery: One-Time (immediate), Scheduled (time-based), or Batching (count/size aggregation)
  5. Deployment warning — Rules are locked in production (enable/disable only). All rule changes must be made in Development and deployed. Max 25 publishers per deployment.
  1. 仅支持控制台操作的服务——若用户期望SDK/API则无法满足。 Catalyst Signals完全通过Catalyst Console配置——没有用于创建发布者、规则或webhooks的SDK、REST API或编程接口。所有设置均通过控制台UI完成。
    • 发布者、事件、webhooks和规则在控制台 → Signals中创建
    • Functions和Circuits需在控制台 → Serverless中单独创建，然后在Signals规则中选择为目标
    • 唯一的代码层面交互是在目标functions/circuits中接收事件
  2. 理解流程——发布者 → 事件 → 规则（含过滤器/转换器）→ 目标（Webhook/Function/Circuit）
  3. 加载
    references/signals-basics.md
    ——了解发布者（Zoho/Catalyst/自定义）、事件、规则、目标、调度策略、事件状态以及部署注意事项
  4. 核心概念：
    • Publishers（发布者）：在操作发生时触发事件（3种类型：Zoho、Catalyst CloudScale、自定义）
    • Events（事件）：带有自动生成 schema 的JSON负载（Zoho发布者最大100KB，自定义发布者最大64KB）
    • Rules（规则）：连接发布者与目标，可添加可选过滤器和负载转换
    • Targets（目标）：通过Webhooks、Functions或Circuits接收事件
    • Dispatch Policy（调度策略）：控制事件交付方式：一次性（即时）、调度型（基于时间）或批量型（按数量/大小聚合）
  5. 部署警告——规则在生产环境中锁定（仅可启用/禁用）。所有规则变更必须在开发环境中完成并部署。每个部署最多支持25个发布者。

Security Checklist

安全检查清单

  • Custom publisher REST API rate limit: 500 requests per minute. Exceeding this locks the API URL for 60 seconds.
  • Environment-specific REST API URLs: Custom event REST API URLs differ between Development and Production — update URLs when deploying.
  • Function/Circuit targets inherit their own permissions: If a function is the target, it runs with whatever scope it was configured with (user or admin). Signals does not override function-level permissions.
  • Event payload size limits: Zoho publishers max 100KB per event (5MB for multi-event batch). Custom publishers max 64KB per event (256KB for up to 25 events).
  • 自定义发布者REST API速率限制：每分钟500次请求。超出限制会锁定API URL 60秒。
  • 环境专属REST API URL：自定义事件REST API URL在开发环境和生产环境中不同——部署时需更新URL。
  • Function/Circuit目标继承自身权限：若函数为目标，则它将以自身配置的权限范围（用户或管理员）运行。Signals不会覆盖函数级权限。
  • 事件负载大小限制：Zoho发布者每个事件最大100KB（多事件批量最大5MB）。自定义发布者每个事件最大64KB（最多25个事件时最大256KB）。

Triggers

触发场景

Use this skill for: "Signals", "Catalyst event bus", "event-driven architecture", "publisher", "Zoho publisher", "Catalyst publisher", "custom publisher", "event schema", "rule", "event filter", "event transformation", "webhook target", "dispatch policy", "one-time dispatch", "scheduled dispatch", "batch dispatch", "event ordering", "retry policy", "TTL", "event status", "Signals logs", "Signals dashboard", "deploy Signals", or "Signals console".
当涉及以下内容时使用此技能：「Signals」、「Catalyst event bus」、「event-driven architecture」、「publisher」、「Zoho publisher」、「Catalyst publisher」、「custom publisher」、「event schema」、「rule」、「event filter」、「event transformation」、「webhook target」、「dispatch policy」、「one-time dispatch」、「scheduled dispatch」、「batch dispatch」、「event ordering」、「retry policy」、「TTL」、「event status」、「Signals logs」、「Signals dashboard」、「deploy Signals」或「Signals console」。

References

参考资料

ReferenceLoad when the query is about…
references/signals-basics.md
Publishers (Zoho/Catalyst/Custom), events and schemas, custom event REST API, rules and filters, targets (webhooks/functions/circuits), dispatch policies (One-Time/Scheduled/Batching), event transformation, retry policies, event ordering, event statuses, logs, dashboard, deployment limits, production restrictions
参考资料查询以下内容时加载…
references/signals-basics.md
发布者（Zoho/Catalyst/自定义）、事件与schema、自定义事件REST API、规则与过滤器、目标（webhooks/functions/circuits）、调度策略（一次性/调度型/批量型）、事件转换、重试策略、事件排序、事件状态、日志、仪表盘、部署限制、生产环境限制