---
title: "カスタムイベントのサンプルペイロード"
url: https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/sample-payload-custom-event/
description: "Catalystでは、CLIを使用してCatalyst Event Listenersがサポートするさまざまなイベントソースからサンプルペイロードを生成できます。"
last_updated: 2026-08-17T12:16:04Z
service: All Services
type: general
---

# カスタムイベントソースのサンプルペイロード生成

> **注意:** 

* Event Listenersコンポーネントは現在非推奨となっています。より新しく堅牢なイベントバスサービスである**Catalyst Signals**への移行を強くお勧めします。[Catalyst Signalsの詳細はこちら](https://docs.catalyst.zoho.com/ja/signals/help/events/)。

* [Catalyst Publishersをソースとするイベントのペイロード生成について学ぶ](https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/sample-payload-catalyst-pub/)。

### ペイロード生成

[カスタムイベントリスナー](https://docs.catalyst.zoho.com/ja/cloud-scale/help/event-listeners/custom-event-listeners/)は、エンドユーザーがそのURLを呼び出すたびにターゲットFunctionにデータを渡すために使用されます。カスタムイベントリスナーには複数のルールを含めることができ、異なるターゲットFunctionsに関連付けることができます。カスタムイベントリスナーのすべてのルールは同じURLエンドポイントを持ちますが、各ルールには作成時に設定できる一意の**ルール識別子**変数が含まれます。これにより、呼び出す特定のルールを示すことができます。

> **注意:** カスタムイベントリスナーはデフォルトではプロジェクトに存在しません。そのため、サンプルペイロードを生成するには、まずリモートコンソールからプロジェクトにカスタムイベントリスナーを作成する必要があります。ただし、この目的のためにルールを作成する必要はありません。サンプルペイロードの生成時にCLIでテスト目的のルールを作成できます。これはコンソールで設定されたカスタムイベントリスナーには反映されません。

同じコマンドを実行してカスタムイベントのサンプルペイロードを生成できます：

```sh
 catalyst event:generate|generate:event [options] <source> <action> 
```

ただし、Catalystはカスタムイベントソースに対して以下のソースとアクションの値のみを受け付けます：

<table class="content-table">
<thead>
<tr>
<th><strong>ソース</strong></th>
<th><strong>アクション</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="badge">custom</span></td>
<td><span class="badge">Produce</span></td>
</tr>
</tbody>
</table>

### 必須コマンドオプション

カスタムイベントのサンプルペイロードを生成する際には、以下のオプションを**必須で**使用する必要があります：

#### -e | -\-event-bus <event\_bus\_name>

`\--event-bus`オプションは、前のセクションで説明したのと同じ機能を実行します。サンプルペイロードで使用するイベントバスの名前を指定できます。`event\_bus\_details` JSONには、渡された名前がバス名として含まれます。

#### -rid | -\-rule-id <rule\_identifier>

`\--rule-id`オプションを使用すると、カスタムイベントペイロードで使用するルール識別子を指定できます。前述のとおり、ルール識別子はカスタムイベントバス内のルールを一意に識別します。JSONの`data`フィールドにルール識別子が含まれます。

カスタムイベントのサンプルペイロードを生成し、イベントバス名とルール識別子を渡すには、次のコマンドを実行します：

```sh
 catalyst event:generate|generate:event custom Produce --event-bus TrackerRequests --rule-id DomesticTracking 
```

これにより、次のJSONペイロードが生成されます。ペイロードには、プロジェクトの詳細、指定したイベントバスとルール識別子の詳細、およびその他のサンプルデータが含まれます。

![Custom Event Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_custom.webp)

> **注意:** **Visual Studio Code IDE**ユーザーの場合、**Catalyst Tools**拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してEvent Functionsをデバッグする手順は[こちら](https://docs.catalyst.zoho.com/ja/catalyst-extensions/vs-code-extension/implementation/#run-or-debug-a-function)をご覧ください。