---
title: "Sample Payload for Integration Functions"
url: https://docs.catalyst.zoho.com/en/cli/v1/event-generate/sample-payload-integration-functions/
description: "Catalyst enables you to generate sample payloads for Integration functions using the CLI."
last_updated: 2026-08-28T06:26:16Z
service: All Services
type: general
---

# Generate Sample Payload to Test Integration Functions

### Payload Generation

[Integration functions](https://docs.catalyst.zoho.com/en/serverless/help/functions/integration-functions/) enable you to code and use a Catalyst function as the backend of other Zoho services, and establish an integration with them. Catalyst currently supports integration with [Zoho Cliq](https://www.zoho.com/in/cliq/) and [ConvoKraft Bot Logic](https://docs.catalyst.zoho.com/en/convokraft/help/actions/bot-logic/catalyst-integration-functions/) through Integration functions.

You can develop the backend of [Cliq extensions](https://www.zoho.com/cliq/help/platform/getting-started-with-cliq-platform.html) that bundle bots, commands, message actions, widgets, and functions through Integration functions. The CLI enables you to generate sample payloads for various handlers in each of these tools.

> **Note:** Cliq Integration Functions is currently not available to Catalyst users accessing from the EU, AU, IN, or CA data centers. ConvoKraft Integration Functions are available to users accessing from all DCs.

The general command to generate a sample payload to test an Integration function in the CLI is:

```sh
 catalyst event:generate:integ [options] <service> 
```

Because Catalyst only supports integrations with Cliq currently, you must provide the following value as the service: ` **ZohoCliq** `.

Catalyst supports the following Cliq components and handler classes that you can generate a sample payload for, in the CLI.

<table class="content-table">
<thead>
<tr>
<th>Component</th>
<th>Handler Classes</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="badge">bot</span></td>
<td><span class="badge">welcome_handler</span>
<span class="badge">message_handler</span> 
<span class="badge">context_handler</span> 
<span class="badge">mention_handler</span>
<span class="badge">action_handler</span>
 <span class="badge">incomingwebhook_handler</span>
 <span class="badge">participation_handler</span></td>
</tr>
<tr>
<td><span class="badge">command</span></td>
<td><span class="badge">execution_handler</span> 
<span class="badge">suggestion_handler</span></td>
</tr>
<tr>
<td><span class="badge">messageaction</span></td>
<td><span class="badge">execution_handler</span></td>
</tr>
<tr>
<td><span class="badge">widget</span></td>
<td><span class="badge">view_handler</span></td>
</tr>
<tr>
<td><span class="badge">function</span></td>
<td><span class="badge">button_handler</span> 
<span class="badge">form_handler</span> 
<span class="badge">form_change_handler</span> 
<span class="badge">form_values_handler</span> 
<span class="badge">widget_button_handler</span></td>
</tr>
<tr>
<td><span class="badge">installation</span></td>
<td><span class="badge">installation_handler installation_validator</span></td>
</tr>
</tbody>
</table>

1. Execute the following command to select the component and a handler class to
generate the payload for:

```sh
 catalyst event:generate:integ ZohoCliq 
```

2. Select a component from the list and press **Enter** .
 ![Integration Functions Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_integ_1.webp)

3. Select a handler class from the list and press **Enter** .
 ![Integration Functions Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_integ_2.webp)

The CLI will generate a sample JSON payload for that component and handler source. Depending on the component, the payload will contain relevant data.

![Integration Functions Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_integ_3.webp)

You can also directly save the JSON payload into a file instead of displaying it in the CLI.

### Integration Functions Event Generation Options

#### \--inputs &lt;inputs&gt;

You can generate a sample payload to test Integration functions by directly specifying the component and the handler you require the data for. The inputs must be specified in the following format:

```sh
 catalyst event:generate:integ ZohoCliq --inputs component,handler 
```

For example, to generate a sample payload for a `form\_handler` class for the `function` component, execute the following command:

```sh
  catalyst event:generate:integ ZohoCliq --inputs function,form_handler  
```

This will generate the following JSON payload.

![Integration Functions Payload Generation](https://catalyst-docs-development.zohostratus.in/images/cli/event-generate/catalyst_cli_eventgen_integ_inputs.webp)

Refer to the table shown above for a list of Cliq components and handler classes supported by Catalyst.

> **Note:** If you are a **Visual Studio Code IDE** user, you can install the **Catalyst Tools** extension, and perform CLI operations using your IDE in place of the CLI. Steps to debug your event functions using Visual Studio Code IDE can be found [here](https://docs.catalyst.zoho.com/en/catalyst-extensions/vs-code-extension/implementation/#run-or-debug-a-function).