# Canny

Canny is a customer feedback management platform that helps teams collect, analyze, and prioritize user feedback to build better products.

- **Category:** product management
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 25
- **Triggers:** 0
- **Slug:** `CANNY`
- **Version:** 20260227_00

## Tools

### Add Post Tag

**Slug:** `CANNY_ADD_POST_TAG`

Tool to add a tag to a specific post. Use when you need to categorize or group content by applying an existing tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tagID` | string | Yes | Unique identifier of the tag to add to the post. |
| `postID` | string | Yes | Unique identifier of the post to which the tag will be added. |

#### 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 |

### Change Post Status

**Slug:** `CANNY_CHANGE_POST_STATUS`

Tool to change a post's status. Use when you need to update a post's workflow stage and optionally notify voters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `postID` | string | Yes | The unique identifier (MongoDB ObjectID) of the post whose status will be changed. |
| `status` | string | Yes | New status for the post. Common values include 'open', 'under review', 'planned', 'in progress', 'complete', 'closed', or any custom status configured in Canny. |
| `changerID` | string | Yes | The unique identifier (MongoDB ObjectID) of the admin user who is making the status change. Must be an admin user in Canny. |
| `commentValue` | string | No | Optional comment to accompany the status change. This will be shown in the post's activity feed. Supports newlines with '\n'. |
| `commentImageURLs` | array | No | Optional list of image URLs to attach to the status change comment. Must be valid, publicly accessible URLs. |
| `shouldNotifyVoters` | boolean | No | Whether non-admin voters should be notified of the status change. Defaults to False to avoid unexpected notifications in automated workflows. |

#### 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 Changelog Entry

**Slug:** `CANNY_CREATE_CHANGELOG_ENTRY`

Tool to create and optionally publish a new changelog entry. Use when you need to add a product update record, control publish timing, and notify users. Example: "Create changelog entry titled 'Version 1.2' with details '...' and publish immediately.".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("fixed" | "new" | "improved") | No | Optional type of your changelog entry: 'fixed', 'new', or 'improved'. |
| `title` | string | Yes | The title of your changelog entry. |
| `notify` | boolean | No | If publishing immediately, whether to notify users by email. Defaults to false. |
| `details` | string | Yes | The Markdown-formatted details of your changelog entry. |
| `postIDs` | array | No | List of post IDs to link to this changelog entry. |
| `labelIDs` | array | No | List of label IDs to assign to this changelog entry. |
| `published` | boolean | No | Whether to publish the entry immediately. Defaults to false. |
| `publishedOn` | string | No | If 'published' is true, override the publish date (ISO 8601 format, must not be in the future). |
| `scheduledFor` | string | No | Schedule a future publish date (ISO 8601 format, must be in the future). |

#### 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 Comment

**Slug:** `CANNY_CREATE_COMMENT`

Tool to create a new comment on a post. Use when you have the authorID and postID and want to submit feedback or replies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | No | Text content of the comment, up to 2500 characters. Required if no images. |
| `postID` | string | Yes | Unique identifier of the post to which the comment is added (Canny post ID). Use the 'List Posts' action to get valid post IDs. |
| `authorID` | string | Yes | Unique identifier of the comment's author (Canny user ID). Use the 'Create or Update User' action to get a valid user ID. |
| `internal` | boolean | No | Flag for internal-use-only comments. Can only be true if the author is a company member. |
| `parentID` | string | No | If this comment is a reply, the unique identifier of the parent comment (Canny comment ID). |
| `createdAt` | string | No | Original creation timestamp in ISO 8601 format (useful for migrating comments) |
| `imageURLs` | array | No | List of image URLs to attach to the comment. |
| `shouldNotifyVoters` | boolean | No | Whether to send email notifications to voters of the post. |

#### 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 or Update User

**Slug:** `CANNY_CREATE_OR_UPDATE_USER`

Creates a new user or updates an existing user in Canny. If a user with the given identifier (email, userID, or id) already exists, their profile is updated; otherwise, a new user is created. IMPORTANT: At least one of 'email', 'userID', or 'id' must be provided along with 'name'. Use cases: - Sync users from your application to Canny - Update user profiles (name, avatar, custom fields) - Associate users with companies for segmentation Example: Create user with email: {"name": "Jane Doe", "email": "jane@example.com"} Example: Sync app user: {"name": "John Smith", "userID": "app_user_123", "email": "john@example.com"}

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Canny's unique identifier for the user. Use this to update an existing Canny user. At least one of 'email', 'userID', or 'id' must be provided. |
| `name` | string | Yes | The user's name (1-50 characters). |
| `alias` | string | No | Optional alias for the user. |
| `email` | string | No | The user's email address. At least one of 'email', 'userID', or 'id' must be provided to identify the user. |
| `userID` | string | No | Your application's unique identifier for the user. Recommended for syncing users between your app and Canny. At least one of 'email', 'userID', or 'id' must be provided. |
| `created` | string | No | Date the user was created in your system (ISO 8601 format). |
| `avatarURL` | string | No | URL to the user's avatar image. |
| `companies` | array | No | List of companies associated with the user. |
| `customFields` | object | No | Custom fields for the user (keys 0-30 chars; string values <200 chars). |

#### 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 Post

**Slug:** `CANNY_CREATE_POST`

Tool to create a new post (feature request or feedback) on a Canny board. Use this action when you need to submit new feedback or feature requests to a board. Requires a valid boardID (from list_boards) and authorID (from create_or_update_user or list_users).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `eta` | string | No | The estimated completion date for this post in MM/YYYY format. |
| `byID` | string | No | The unique identifier of the admin who is creating the post on behalf of the author. Used when an admin submits feedback for a user. |
| `title` | string | Yes | The title of the post. Should be concise and descriptive. |
| `boardID` | string | Yes | The unique identifier of the board where the post will be created. Get this from list_boards action. |
| `details` | string | Yes | The detailed description or body of the post. This is the longer text field explaining the feature request or feedback. |
| `ownerID` | string | No | The unique identifier of the user responsible for completing the work on this post. |
| `authorID` | string | Yes | The unique identifier of the user who is the author of the post. Get this from create_or_update_user or list_users action. |
| `createdAt` | string | No | The original creation date of the post in ISO 8601 format. Useful for migrating posts from another system. |
| `etaPublic` | boolean | No | Whether the ETA should be visible to all users. Defaults to false. |
| `imageURLs` | array | No | List of URLs pointing to images to attach to the post. |
| `categoryID` | string | No | The unique identifier of the category or subcategory to assign to this post. |
| `customFields` | object | No | Custom fields associated with the post. Keys must be 0-30 characters; string values under 200 characters. |

#### 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 Tag

**Slug:** `CANNY_CREATE_TAG`

Tool to create a new tag. Use when you have the boardID and tag name and need to categorize posts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the tag, between 1 and 30 characters. |
| `boardID` | string | Yes | ID of the board where the tag should be created. |

#### 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 Vote

**Slug:** `CANNY_CREATE_VOTE`

Tool to create a vote for a post. Use when you need to record or migrate a user's vote on a post, optionally setting priority or original creation time. Example: Create a vote for postID abc123 with voterID user_456.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `byID` | string | No | The unique identifier of the user casting the vote on behalf of the voter. Must be a Canny administrator. |
| `postID` | string | Yes | The unique identifier of the post to vote on. |
| `voterID` | string | Yes | The unique identifier of the user casting the vote. |
| `createdAt` | string | No | If migrating votes, the original creation timestamp in ISO 8601 format. |
| `votePriority` | integer ("0" | "10" | "20") | No | Priority of the vote: 0 (Nice to have), 10 (Important), or 20 (Must have). |

#### 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 Comment

**Slug:** `CANNY_DELETE_COMMENT`

Tool to delete a comment. Use when moderation is required to remove a specific comment by its id. Example: "Delete the comment with ID 553c3ef8b8cdcd1501ba1238."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `commentID` | string | Yes | The unique identifier of the comment to delete. |

#### 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 Post

**Slug:** `CANNY_DELETE_POST`

Tool to delete a post. Use when you need to permanently remove a post by its id. Example: "Delete the post with ID 553c3ef8b8cdcd1501ba1238."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `postID` | string | Yes | The unique identifier of the post to delete. |

#### 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 User

**Slug:** `CANNY_DELETE_USER`

Tool to delete a user and their comments and votes. Use when you need to fully remove a user’s account and all associated data (e.g., GDPR compliance).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the user to delete. |

#### 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 Vote

**Slug:** `CANNY_DELETE_VOTE`

Tool to delete a vote. Use when you need to remove a user's vote from a specific post by its id. Example: "Delete the vote from postID abc123 for voterID user_456."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `postID` | string | Yes | The unique identifier of the post from which the vote will be removed. |
| `voterID` | string | Yes | The unique identifier of the user whose vote is being removed. |

#### 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 Boards

**Slug:** `CANNY_LIST_BOARDS`

Tool to list all boards. Use when you need to retrieve every board for your company after authentication.

#### 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 Categories

**Slug:** `CANNY_LIST_CATEGORIES`

Tool to list categories. Use when fetching categories for a specific board by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of categories to skip. Defaults to 0 if not specified. |
| `limit` | integer | No | Number of categories to return. Defaults to 10 if not specified. |
| `boardID` | string | No | Filter categories by this board's ID. |

#### 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 Comments

**Slug:** `CANNY_LIST_COMMENTS`

Retrieves a paginated list of comments from Canny. Comments can be filtered by board, post, author, or company. Use this action to: - Get all comments across your Canny instance - Find comments on a specific post (using postID) - List comments from a specific board (using boardID) - See comments by a specific user (using authorID) - Track feedback from a company's users (using companyID) Returns comments ordered by creation date (newest first). Use 'limit' and 'skip' for pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of comments to skip before returning results. Use with 'limit' for pagination (e.g., skip=10, limit=10 returns comments 11-20). |
| `limit` | integer | No | Maximum number of comments to return per request. Use with 'skip' for pagination. |
| `postID` | string | No | The unique identifier of a Canny post. When provided, only comments on this specific post are returned. Obtain this ID from List Posts or Create Post actions. |
| `boardID` | string | No | The unique identifier of a Canny board. When provided, only comments on posts belonging to this board are returned. Obtain this ID from List Boards or Retrieve Board actions. |
| `authorID` | string | No | The unique identifier of a Canny user. When provided, only comments created by this author are returned. Obtain this ID from List Users or Retrieve User actions. |
| `companyID` | string | No | The unique identifier of a company. When provided, only comments on posts created by users linked to this company are returned. Obtain this ID from List Companies action. |

#### 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 Companies

**Slug:** `CANNY_LIST_COMPANIES`

Tool to list companies associated with your Canny account. Use after authentication to retrieve companies with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of companies to return per page (1-100). Defaults to 10. |
| `cursor` | string | No | Pagination cursor from a previous response to fetch the next page of companies. |
| `search` | string | No | A string to search by company name. When used, pagination (cursor) is disabled. |
| `segment` | string | No | The URL name of the segment to filter companies by. |

#### 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 Opportunities

**Slug:** `CANNY_LIST_OPPORTUNITIES`

Tool to list opportunities linked to posts. Use when you need to fetch customer opportunities synced from CRM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of opportunities to skip before returning. Defaults to 0. |
| `limit` | integer | No | Maximum number of opportunities to return. Defaults to 10 if unspecified. |

#### 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 Posts

**Slug:** `CANNY_LIST_POSTS`

Tool to list posts with various filters. Use after selecting a board or to search/filter posts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of posts to skip before fetching; defaults to 0. |
| `sort` | string ("newest" | "oldest" | "relevance" | "score" | "statusChanged" | "trending") | No | Order in which to fetch posts. 'relevance' requires a search value. |
| `limit` | integer | No | Number of posts to fetch; defaults to 10. |
| `search` | string | No | Search query to filter posts by title or details. |
| `status` | string | No | Comma-separated list of statuses to filter by (e.g. 'planned,complete'). |
| `tagIDs` | array | No | Only fetch posts tagged with at least one of these tag IDs. |
| `boardID` | string | No | ID of the board to fetch posts for. |
| `authorID` | string | No | Only fetch posts by this author ID. |
| `companyID` | string | No | Only fetch posts created by users linked to this company identifier. |

#### 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 Tags

**Slug:** `CANNY_LIST_TAGS`

Tool to list tags. Use when fetching tags optionally filtered by board ID and handling pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of tags to skip before returning results. Defaults to 0. |
| `limit` | integer | No | Maximum number of tags to return. Defaults to 10. |
| `boardID` | string | No | Filter tags by this board's ID. |

#### 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 Users

**Slug:** `CANNY_LIST_USERS`

List all end-users in your Canny workspace with pagination support. Use this tool to: - Fetch users from your Canny workspace - Paginate through large user lists using cursor-based pagination - Get user details including email, name, admin status, and custom fields Returns a paginated list of users. Use the returned cursor to fetch subsequent pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of users to fetch per page (1-100). Defaults to 10. |
| `cursor` | string | No | Pagination cursor from a previous response. Use this to fetch the next page of results. |

#### 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 Votes

**Slug:** `CANNY_LIST_VOTES`

Retrieve votes from Canny with optional filtering by board, post, or voter. Use this action to: - Get all votes on a specific post (filter by postID) - Get all votes by a specific user (filter by voterID) - Get all votes on posts in a board (filter by boardID) - List all votes across the account (no filters) Results are paginated - use 'limit' and 'skip' parameters to navigate through pages. Check 'hasMore' in the response to determine if more results are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of votes to skip for pagination. Use with limit to paginate through results. |
| `limit` | integer | No | Maximum number of votes to return (1-10000). Default: 10. |
| `postID` | string | No | Filter votes by post ID. Get post IDs from CANNY_LIST_POSTS. |
| `boardID` | string | No | Filter votes by board ID. Get board IDs from CANNY_LIST_BOARDS. |
| `voterID` | string | No | Filter votes by voter (user) ID. Get user IDs from CANNY_LIST_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 |

### Retrieve Board

**Slug:** `CANNY_RETRIEVE_BOARD`

Tool to retrieve details of a board by its ID. Use when you need metadata for a specific board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the board (24-character hex string). Use CANNY_LIST_BOARDS to get available board IDs. |

#### 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 |

### Retrieve Tag

**Slug:** `CANNY_RETRIEVE_TAG`

Tool to retrieve details of a tag by its ID. Use after obtaining a valid tag ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the tag to retrieve. |

#### 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 |

### Retrieve User

**Slug:** `CANNY_RETRIEVE_USER`

Tool to retrieve user details by Canny user ID, app user ID, or email. Use when you have exactly one identifier and need full user information. Example: "Retrieve user with email user@example.com"

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Canny user ID (provide one of 'id', 'userID', or 'email'). |
| `email` | string | No | User's email address (provide one of 'id', 'userID', or 'email'). |
| `userID` | string | No | Your application user ID (provide one of 'id', 'userID', or 'email'). |

#### 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 |

### Update Post

**Slug:** `CANNY_UPDATE_POST`

Tool to update post details. Use when you need to change a post's title, details, ETA, images, or custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `eta` | string | No | Estimated completion date in MM/YYYY format, e.g., '06/2022'. |
| `title` | string | No | Short title of the post. |
| `postID` | string | Yes | Unique identifier of the post to update. |
| `details` | string | No | Detailed text body of the post. |
| `etaPublic` | boolean | No | Whether the ETA should be visible to end-users. |
| `imageURLs` | array | No | List of image URLs to attach to the post. |
| `customFields` | object | No | Custom fields to set on the post. Keys must be 0-30 characters; values can be string, number, or boolean. |

#### 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 |