# Prisma

Prisma Data Platform provides database tools including Accelerate (global database cache), Optimize (AI-driven query analysis), and Prisma Postgres (managed PostgreSQL). Manage workspaces, projects, environments, and API keys programmatically.

- **Category:** databases
- **Auth:** OAUTH2, API_KEY
- **Composio Managed App Available?** Yes
- **Tools:** 22
- **Triggers:** 0
- **Slug:** `PRISMA`
- **Version:** 20260227_00

## Tools

### Create Database Connection

**Slug:** `PRISMA_CREATE_CONNECTION`

Create new API key connection for database access. Creates connection string with embedded credentials for application database access. Returns complete connection details ready for immediate use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the new connection/API key. This will be displayed in UIs and used for identification. Choose descriptive names like 'Production API Key', 'Analytics Access', 'Dev Environment', etc. |
| `databaseId` | string | Yes | Unique database identifier to create connection for (format: 'db_xxxxx'). Must be a database the authenticated user has write access to. The new connection will provide API key access to this database. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project Database

**Slug:** `PRISMA_CREATE_DATABASE`

Create new postgres database in an existing Prisma project. Creates database in specified region with connection strings and API keys. Returns complete database details ready for immediate use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the new database. This will be displayed in UIs and used for identification. Choose descriptive names like 'Production DB', 'Analytics', etc. |
| `region` | string | Yes | AWS region where the database will be deployed. Valid values: 'us-east-1', 'us-west-1', 'eu-central-1', 'eu-west-3', 'ap-southeast-1', 'ap-northeast-1'. Choose region closest to your users for optimal performance. Use LIST_POSTGRES_REGIONS to get current available regions. |
| `isDefault` | boolean | No | Whether this database should be the default for the project. Default false. Only one database can be default per project. Setting to true will make other databases non-default. |
| `projectId` | string | Yes | Unique project identifier to create database in (format: 'prj_xxxxx'). Must be a project the authenticated user has write access to. The new database will belong to this project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Prisma Project

**Slug:** `PRISMA_CREATE_PROJECT`

Create new Prisma project with managed postgres database. Creates project in authenticated user's workspace with postgres database in specified region. Returns complete project details including connection strings and API keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the new project. This will be displayed in UIs and used for identification. Choose descriptive names like 'Production API', 'Dev Environment', etc. |
| `region` | string | Yes | AWS region where the postgres database will be deployed. Available regions: 'us-east-1', 'us-west-1', 'eu-central-1', 'eu-west-3', 'ap-southeast-1', 'ap-northeast-1'. Choose region closest to your users for optimal performance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Database Connection

**Slug:** `PRISMA_DELETE_CONNECTION`

Permanently delete database connection and revoke API key access. WARNING: This immediately revokes database access for any applications using this connection string. Ensure no critical systems depend on this connection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique connection identifier to delete (format: 'con_xxxxx'). WARNING: This permanently revokes API key access to the database. Any applications using this connection string will lose access immediately. This action cannot be undone - ensure no critical systems depend on this connection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Prisma Database

**Slug:** `PRISMA_DELETE_DATABASE`

Permanently delete Prisma database and all stored data. WARNING: This action cannot be undone. All data in the database will be permanently destroyed. Default databases typically cannot be deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `databaseId` | string | Yes | Unique database identifier to delete (format: 'db_xxxxx'). WARNING: This permanently deletes the database and all stored data. Default databases typically cannot be deleted. This action cannot be undone. Ensure all important data is backed up before deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Prisma Project

**Slug:** `PRISMA_DELETE_PROJECT`

Permanently delete Prisma project and all associated resources. WARNING: This action cannot be undone. All databases, environments, and project data will be permanently destroyed. Use with extreme caution in production environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique project identifier to delete (format: 'proj_xxxxx'). WARNING: This permanently deletes the project and all associated data including databases, environments, and configurations. This action cannot be undone. Ensure all important data is backed up before deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute SQL Command

**Slug:** `PRISMA_EXECUTE_SQL_COMMAND`

Execute SQL commands that modify database data or structure. Runs INSERT, UPDATE, DELETE, CREATE TABLE, and other data modification commands safely through PostgreSQL driver with parameterized query support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `command` | string | Yes | SQL command to execute against the database (INSERT, UPDATE, DELETE, CREATE TABLE, etc.). Examples: 'INSERT INTO users (name, email) VALUES ($1, $2)', 'UPDATE users SET active = $1 WHERE id = $2', 'DELETE FROM sessions WHERE expires_at < NOW()', 'CREATE TABLE logs (id SERIAL PRIMARY KEY, message TEXT, created_at TIMESTAMP DEFAULT NOW())' |
| `parameters` | array | No | Optional array of parameters for parameterized commands using $1, $2, etc. placeholders. Example: command='INSERT INTO users (name, email) VALUES ($1, $2)', parameters=['John Doe', 'john@example.com']. Parameters are automatically escaped to prevent SQL injection. |
| `connectionString` | string | Yes | PostgreSQL connection string for direct database access. Use the standard format: 'postgresql://USER:PASSWORD@HOST:PORT/DATABASE?sslmode=require'. Get credentials from create_connection or create_database response fields: use 'user' as USER, 'pass' as PASSWORD, and 'host' as HOST:PORT. Example: 'postgresql://abc123:sk_xyz@db.prisma.io:5432/postgres?sslmode=require'. Note: Do NOT use Prisma Accelerate URLs (prisma+postgres://accelerate.prisma-data.net/...) - those are for Prisma Client SDK only. Use the direct connection credentials instead. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute SQL Query

**Slug:** `PRISMA_EXECUTE_SQL_QUERY`

Execute SQL SELECT queries against Prisma Postgres databases. Runs read-only queries safely through direct PostgreSQL connection with SSL. Uses credentials from create_connection action (host, user, pass fields). Perfect for data analysis, schema inspection, and reporting operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `host` | string | Yes | Database host with port (format: 'db.prisma.io:5432'). Obtain this from create_connection action response field 'host'. This is the direct PostgreSQL endpoint for your Prisma Postgres database. |
| `user` | string | Yes | Database username (tenant ID from Prisma). Obtain this from create_connection action response field 'user'. This is a unique identifier for your database tenant. |
| `query` | string | Yes | SQL SELECT query to execute against the database. Use standard PostgreSQL syntax. Common examples: 'SELECT * FROM users LIMIT 10', 'SELECT name, email FROM customers WHERE active = true', 'SELECT table_name FROM information_schema.tables WHERE table_schema = \'public\''. Avoid INSERT/UPDATE/DELETE - use execute_sql_command for those operations. |
| `password` | string | Yes | Database password (secret key from Prisma). Obtain this from create_connection action response field 'pass'. Format is typically 'sk_xxxxx'. Keep this secure. |
| `parameters` | array | No | Optional array of parameters for parameterized queries using %s placeholders. Example: query='SELECT * FROM users WHERE id = %s AND active = %s', parameters=[123, true]. Parameters are automatically escaped to prevent SQL injection. Use %s for each parameter in order they appear in the query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Prisma Database

**Slug:** `PRISMA_GET_DATABASE`

Retrieve specific Prisma database by ID. Returns database details including status, project context, and regional deployment. Use for database monitoring, validation, and administrative operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `databaseId` | string | Yes | Unique database identifier to retrieve (format: 'db_xxxxx'). This ID is obtained from database listing or creation operations. Must be a database the authenticated user has access to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Database Usage Metrics

**Slug:** `PRISMA_GET_DATABASE_USAGE`

Retrieve usage metrics for a specific Prisma database. Returns metrics including storage usage and operation counts (reads/writes) for the specified time period. Use for monitoring resource consumption, cost analysis, and capacity planning.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endDate` | string | No | End date for metrics query in ISO 8601 format (e.g., '2025-07-31T23:59:59Z'). Defaults to current date if not provided. Will be set to end of day if a future date is provided. |
| `startDate` | string | No | Start date for metrics query in ISO 8601 format (e.g., '2025-07-01T00:00:00Z'). Defaults to start of current month if not provided. Use to specify custom date ranges for usage analysis. |
| `databaseId` | string | Yes | Unique database identifier to retrieve usage metrics for (format: 'db_xxxxx'). Must be a database the authenticated user has access to. This ID is obtained from database listing or creation operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Prisma Project

**Slug:** `PRISMA_GET_PROJECT`

Retrieve specific Prisma project by ID. Returns project details including name, creation timestamp, and workspace information. Use for project detail views, validation, and administrative operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique project identifier to retrieve (format: 'proj_xxxxx'). This ID is obtained from project listing or creation operations. Must be a project the authenticated user has access to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Inspect Database Schema

**Slug:** `PRISMA_INSPECT_DATABASE_SCHEMA`

Inspect database schema structure and table information. Returns comprehensive schema details including tables, columns, data types, constraints, and relationships. Essential for understanding database structure before executing queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `host` | string | Yes | Database host with port (format: 'db.prisma.io:5432'). Obtain this from create_connection action response field 'host'. This is the direct PostgreSQL endpoint for your Prisma Postgres database. |
| `user` | string | Yes | Database username (tenant ID from Prisma). Obtain this from create_connection action response field 'user'. This is a unique identifier for your database tenant. |
| `password` | string | Yes | Database password (secret key from Prisma). Obtain this from create_connection action response field 'pass'. Format is typically 'sk_xxxxx'. Keep this secure. |
| `tableName` | string | No | Optional specific table name to inspect. If provided, returns detailed column information for that table only. If omitted, returns overview of all tables in the database. Use for focused schema analysis of specific tables. |
| `includeIndexes` | boolean | No | Whether to include index information in the schema results. When true, shows primary keys, foreign keys, and other indexes. Useful for understanding table relationships and query optimization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prisma Accelerate Regions

**Slug:** `PRISMA_LIST_ACCELERATE_REGIONS`

Retrieve all available regions for Prisma Accelerate. Returns regions where Accelerate global database cache can be deployed. Use for cache region selection to minimize latency for your users.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Database Backups

**Slug:** `PRISMA_LIST_BACKUPS`

Retrieve list of available backups for a specific database. Returns backup details including status, size, type, and restoration readiness. Use for backup monitoring, restoration planning, and compliance auditing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of backups to return in a single request. Defaults to 25 if not specified. Typical range is 1-100. Use smaller values (10-25) for UI pagination, larger values (50-100) for processing. |
| `databaseId` | string | Yes | Unique database identifier to list backups for (format: 'db_xxxxx'). Must be a database the authenticated user has access to. All available backups for this database will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Database Connections

**Slug:** `PRISMA_LIST_CONNECTIONS`

Retrieve paginated list of connections for a specific database. Returns connection details including names, creation dates, and database context. Use for API key management, security audits, and access control.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of connections to return in a single request. Defaults to 100 if not specified. Valid range is typically 1-500. Use smaller values (10-50) for faster responses when you only need a few connections, or larger values (100-500) when bulk processing. |
| `cursor` | string | No | Pagination cursor for retrieving the next page of results. Use the 'nextCursor' value from a previous response to get subsequent pages. Leave as None/null for the first page. Enables efficient pagination through large numbers of connections without missing or duplicating entries. |
| `databaseId` | string | Yes | Unique database identifier to list connections for (format: 'db_xxxxx'). Must be a database the authenticated user has access to. All connection strings and API keys for this database will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Databases

**Slug:** `PRISMA_LIST_DATABASES`

Retrieve paginated list of databases for a specific Prisma project. Returns database details including status, region, and project context. Use for database discovery, monitoring, and project administration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of databases to return in a single request. Defaults to 100 if not specified. Valid range is typically 1-500. Use smaller values (10-50) for faster responses when you only need a few databases, or larger values (100-500) when bulk processing. |
| `cursor` | string | No | Pagination cursor for retrieving the next page of results. Use the 'nextCursor' value from a previous response to get subsequent pages. Leave as None/null for the first page. Enables efficient pagination through large numbers of databases without missing or duplicating entries. |
| `projectId` | string | Yes | Unique project identifier to list databases for (format: 'prj_xxxxx'). Must be a project the authenticated user has access to. All databases belonging to this project will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prisma Postgres Regions

**Slug:** `PRISMA_LIST_POSTGRES_REGIONS`

Retrieve all available regions for Prisma Postgres. Returns regions where Prisma Postgres databases can be deployed with current availability status. Use for region selection during database creation and capacity planning.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prisma Projects

**Slug:** `PRISMA_LIST_PROJECTS`

Retrieve paginated list of Prisma projects accessible to authenticated user. Returns project IDs, names, workspace info, and timestamps with cursor-based pagination. Use for project discovery, UI selection flows, and administrative operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of projects to return in a single request. Defaults to 100 if not specified. Valid range is typically 1-500. Use smaller values (10-50) for faster responses when you only need a few projects, or larger values (100-500) when bulk processing. The API may return fewer results than requested if fewer projects exist. |
| `cursor` | string | No | Pagination cursor for retrieving the next page of results. Use the 'nextCursor' value from a previous response to get subsequent pages. Leave as None/null for the first page. This enables efficient pagination through large numbers of projects without missing or duplicating entries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspace Integrations

**Slug:** `PRISMA_LIST_WORKSPACE_INTEGRATIONS`

Retrieve paginated list of integrations for a specific Prisma workspace. Returns integration details including OAuth client info, granted scopes, and creator. Use for security audits, integration management, and workspace administration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of integrations to return in a single request. Defaults to 100 if not specified. Valid range is typically 1-500. Use smaller values (10-50) for faster responses when you only need a few integrations, or larger values (100-500) when bulk processing. |
| `cursor` | string | No | Pagination cursor for retrieving the next page of results. Use the 'nextCursor' value from a previous response to get subsequent pages. Leave as None/null for the first page. Enables efficient pagination through large numbers of integrations without missing or duplicating entries. |
| `workspaceId` | string | Yes | Unique workspace identifier to list integrations for (format: 'wksp_xxxxx'). Must be a workspace the authenticated user has access to. All integrations belonging to this workspace will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prisma Workspaces

**Slug:** `PRISMA_LIST_WORKSPACES`

Retrieve paginated list of Prisma workspaces accessible to authenticated user. Returns workspace IDs, names, creation timestamps with cursor-based pagination. Use for workspace discovery, UI selection flows, and administrative operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of workspaces to return in a single request. Defaults to 100 if not specified. Valid range is typically 1-500. Use smaller values (10-50) for faster responses when you only need a few workspaces, or larger values (100-500) when bulk processing. The API may return fewer results than requested if fewer workspaces exist. |
| `cursor` | string | No | Pagination cursor for retrieving the next page of results. Use the 'nextCursor' value from a previous response to get subsequent pages. Leave as None/null for the first page. This enables efficient pagination through large numbers of workspaces without missing or duplicating entries. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Database Backup

**Slug:** `PRISMA_RESTORE_BACKUP`

Restore database backup to new database instance. Creates new database from existing backup with specified name. Operation is asynchronous - monitor the returned database status for completion. Restoration may take several minutes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `backupId` | string | Yes | Unique backup identifier to restore. Must be a completed backup from the specified database. Use list_backups action to find available backup IDs. |
| `databaseId` | string | Yes | Unique source database identifier containing the backup (format: 'db_xxxxx'). Must be a database the authenticated user has access to. The backup will be restored from this database's backup collection. |
| `targetDatabaseName` | string | Yes | Name for the new database created from backup restoration. This will be displayed in UIs and used for identification. Choose descriptive names like 'Restored DB 2025-01-20', 'Production Rollback', etc. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Transfer Prisma Project

**Slug:** `PRISMA_TRANSFER_PROJECT`

Transfer Prisma project ownership to another user's workspace. Transfers project ownership from the current authenticated user to the recipient specified by their OAuth2 access token. This is typically used in partner integrations where databases are provisioned on the partner's workspace and later transferred to end users. The project and all its databases are moved to the recipient's workspace. The current owner loses access unless the new owner explicitly grants it. Requirements: - Valid project ID owned by the current user - Valid OAuth2 access token for the recipient user - Recipient workspace must have sufficient quota for the project

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique project identifier to transfer (format: 'proj_xxxxx'). Obtain from PRISMA_LIST_PROJECTS or PRISMA_CREATE_PROJECT response. Must be a project owned by the authenticated user's workspace. After transfer, the current user loses access unless explicitly granted by the new owner. |
| `recipientAccessToken` | string | Yes | OAuth2 access token of the recipient user who will receive project ownership. This token must be obtained through Prisma's OAuth2 flow for the recipient user. The recipient workspace must have sufficient quota to receive the project. Typically used in partner integrations to transfer provisioned databases to end users. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |