# Helpwise

Helpwise is an easy-to-use customer service platform that helps you manage all customer communication from a single place.

- **Category:** customer support
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 38
- **Triggers:** 0
- **Slug:** `HELPWISE`
- **Version:** 20260307_00

## Tools

### Create attachment

**Slug:** `HELPWISE_CREATE_ATTACHMENT`

Tool to upload a new attachment. Use when you need to send a file to Helpwise and receive its attachment metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload to Helpwise. |
| `conversation_id` | string | No | ID of the conversation to associate this attachment with. If provided, the attachment will be linked to the specified conversation. Leave empty to create an unattached attachment. |

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

### Add note to conversation

**Slug:** `HELPWISE_CREATE_NOTE`

Tool to add a note to a conversation. Use after obtaining the conversation_id to provide context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Content of the note |
| `private` | boolean | No | Flag indicating if the note is internal (private) and not visible to the customer |
| `conversation_id` | string | Yes | Unique identifier of the conversation to which the note 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 |

### Create Helpwise Team

**Slug:** `HELPWISE_CREATE_TEAM`

Creates a new team in Helpwise to group users for collaboration and assignment purposes. Use this tool when you need to: - Create a new team with a unique name - Optionally add a description for the team - Optionally assign initial members by their user IDs IMPORTANT: Team creation via API is not available in the current Helpwise API. All tested endpoints (/api/v1/teams, /dev-apis/teams, /api/v1/team, /dev-apis/team) return 404. Team management appears to be limited to the Helpwise web interface. If you need to create teams, please: 1. Use the Helpwise web interface at https://app.helpwise.io 2. Contact Helpwise support at dev@helpwise.io to request API endpoint availability This action is implemented speculatively for future API support and follows standard patterns used in other Helpwise actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the team to create (must be unique within your workspace) |
| `member_ids` | array | No | List of user IDs to add to the team upon creation |
| `description` | string | No | Optional description for the team |

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

**Slug:** `HELPWISE_CREATE_WEBHOOK`

Creates a new webhook subscription in Helpwise to receive real-time event notifications. Use this action to programmatically subscribe to Helpwise events like conversation creation, message replies, conversation assignments, status changes, and tag applications. Webhooks deliver JSON payloads to your specified callback URL when subscribed events occur. IMPORTANT: Helpwise webhook management is primarily done through the UI at: Settings > Automation > Integrations > Webhooks (https://app.helpwise.io/settings/integrations) This action attempts to use programmatic API endpoints, but if they're unavailable in your Helpwise plan or environment, you'll need to create webhooks manually via the UI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Target URL for receiving webhook events (must return 200 status, not 404) |
| `events` | array | Yes | List of event names to subscribe to. Common events: 'conversation.created', 'conversation.assigned', 'conversation.closed', 'message.created' |
| `secret` | string | No | Optional secret key to validate webhook authenticity and ignore unauthorized requests |
| `is_active` | boolean | No | Whether the webhook should be active immediately upon creation |

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

**Slug:** `HELPWISE_DELETE_CONTACT`

Deletes a contact from Helpwise by its unique identifier (ID). Use this action when you need to permanently remove a contact from your Helpwise account. Returns an empty response (HTTP 204 No Content) on successful deletion. Note: This action is idempotent - deleting a non-existent contact will return an appropriate error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | The unique identifier (ID) of the contact to delete. This can be obtained from contact listing endpoints or contact creation responses. |

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

**Slug:** `HELPWISE_DELETE_CONVERSATION`

Attempts to delete a conversation by ID from Helpwise. Note: The Helpwise API may not support conversation deletion via the REST API. If deletion is not supported, this action will return an error indicating that the endpoint was not found or the method is not allowed. Use this action when you need to attempt to permanently remove a conversation by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | Unique ID of the conversation 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 Mailbox

**Slug:** `HELPWISE_DELETE_MAILBOX`

Tool to delete a mailbox by its unique identifier. NOTE: As of 2026, the Helpwise API may not support mailbox deletion via API. This action attempts deletion but will fail if the endpoint is not available (405 Method Not Allowed). Consider managing mailboxes through the Helpwise web interface if API deletion is unsupported.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mailbox_id` | string | Yes | The unique identifier (ID) of the Helpwise mailbox to delete. This should be a numeric or alphanumeric string obtained from mailbox listing endpoints. |

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

**Slug:** `HELPWISE_DELETE_MESSAGE`

Attempts to delete a message from Helpwise. Note: The Helpwise API may not support message deletion via the REST API. If deletion is not supported, this action will return an error indicating that the DELETE method is not allowed (HTTP 405). Use this action when you need to attempt to permanently remove a message by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | Unique identifier of the Helpwise message 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 Helpwise Note

**Slug:** `HELPWISE_DELETE_NOTE`

Tool to delete a note from a conversation. Use when you need to permanently remove a note by its ID from a specific conversation after confirming the IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | string | Yes | Unique ID of the note to delete |
| `conversation_id` | string | Yes | Unique ID of the conversation containing the note |

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

**Slug:** `HELPWISE_DELETE_SIGNATURE`

Deletes an email signature from Helpwise. Email signatures are text/HTML templates that automatically append to outgoing emails from specific mailboxes or users. This action permanently removes the signature identified by the signature_id. Returns an empty response on successful deletion (204 No Content).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signature_id` | string | Yes | Unique identifier of the email signature to delete. Email signatures are templates that automatically append to outgoing emails. The ID can be obtained from the signature management interface in Helpwise settings. |

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

**Slug:** `HELPWISE_DELETE_TAG`

Permanently deletes a tag from Helpwise. This action removes the tag from all conversations where it was applied and cannot be undone. Use this when you need to permanently remove a tag that is no longer needed. Note: Deleting a tag will automatically remove it from all existing conversations that use this tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | The unique identifier (ID) of the tag to permanently delete. You can obtain tag IDs from the HELPWISE_GET_TAG action, from conversation responses, or from the Helpwise web interface. |

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

**Slug:** `HELPWISE_DELETE_TEAM`

Tool to delete a team. Use when you need to remove an existing team by its unique identifier after confirming the ID and dependencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | Unique identifier of the Helpwise team 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 Template

**Slug:** `HELPWISE_DELETE_TEMPLATE`

Deletes a Helpwise email template (saved reply) by its ID. Returns empty response on success (HTTP 204). Use this tool when you need to permanently remove a template that is no longer needed. Ensure the template_id is valid before deletion - this operation cannot be undone. Common responses: - Success (204): Template deleted successfully - Not Found (404): Template ID does not exist or was already deleted - Forbidden (403): No permission to delete this template

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Unique identifier of the Helpwise template 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 Helpwise Webhook

**Slug:** `HELPWISE_DELETE_WEBHOOK`

Delete a Helpwise webhook by its ID. Use this tool when you need to permanently remove a webhook configuration. Returns an empty response on successful deletion (HTTP 204 No Content).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Unique identifier of the Helpwise webhook 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 |

### Get Attachment

**Slug:** `HELPWISE_GET_ATTACHMENT`

Retrieves a specific attachment by its unique identifier. Use this after obtaining an attachment ID from conversations, messages, or attachment listings to get detailed attachment metadata including download URL, file name, content type, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | string | Yes | The unique ID of the attachment you want to retrieve. Obtain this from conversations, messages, or by listing attachments. |

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

**Slug:** `HELPWISE_GET_ATTACHMENTS`

Retrieves attachments from messages in a specific conversation. **Important**: Helpwise does not provide a dedicated attachments endpoint. This action retrieves attachments by fetching messages from the conversation and extracting attachment information from them. A conversation_id is required to use this action. Use this when you need to: - Get all file attachments from a specific conversation - Access attachment metadata (filename, URL, size, content type) - Download files shared in customer support conversations **Note**: This action retrieves attachments through the messages endpoint, as Helpwise embeds attachment data within message objects rather than providing a standalone attachments resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | Unique identifier of the conversation to fetch attachments for. Required - Helpwise retrieves attachments through messages, which must be scoped to a conversation. |

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

**Slug:** `HELPWISE_GET_CONTACT`

Retrieves detailed information for a specific contact by ID. Use this when you need to fetch complete contact details including name, email, phone, company, and timestamps for a known contact ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact 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 |

### Get Conversation

**Slug:** `HELPWISE_GET_CONVERSATION`

Retrieves complete details of a specific conversation by ID from Helpwise. Returns the conversation metadata including subject, status, participants, and timestamps. Use this action when you need to view or analyze a specific conversation's details. Example use cases: - Checking the status of a support ticket conversation - Viewing conversation participants and assignees - Retrieving conversation metadata for reporting

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | Unique identifier of the conversation 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 |

### Get Conversations

**Slug:** `HELPWISE_GET_CONVERSATIONS`

Tool to retrieve a list of conversations. Use when you need to list and paginate support conversations for display or analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve, must be >= 1 |
| `search` | string | No | Search term to filter conversations |
| `status` | string ("open" | "closed" | "pending" | "draft") | No | Filter by conversation status |
| `sort_by` | string ("created_at" | "updated_at") | No | Field to sort by |
| `team_id` | string | No | Filter by team ID handling the conversation |
| `per_page` | integer | No | Items per page, must be >= 1 |
| `mailbox_id` | string | No | Mailbox ID to retrieve conversations from. If not provided, retrieves conversations across all mailboxes. |
| `sort_order` | string ("asc" | "desc") | No | Sort order: asc or desc |
| `assignee_id` | string | No | Filter by assignee user ID |
| `requester_id` | string | No | Filter by requester user 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 |

### Get Helpwise Custom Field

**Slug:** `HELPWISE_GET_CUSTOM_FIELD`

Retrieves details of a specific custom field by its ID. Use this when you need to fetch custom field properties such as name, description, value, associated inboxes, and creator information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_id` | integer | Yes | Unique identifier of the custom field 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 |

### Get Helpwise Mailbox

**Slug:** `HELPWISE_GET_MAILBOX`

Tool to retrieve details of a specific mailbox by its ID. Use when you know the mailbox ID and need full mailbox information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mailbox_id` | string | Yes | Unique identifier of the mailbox 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 |

### Get Helpwise Mailboxes

**Slug:** `HELPWISE_GET_MAILBOXES`

Tool to retrieve mailboxes. Use when you need to list and paginate mailboxes after authenticating.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to fetch, must be 1 or greater |
| `per_page` | integer | No | Number of mailboxes per page, maximum 100 |

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

**Slug:** `HELPWISE_GET_NOTE`

Tool to retrieve details of a specific note. Use when you know the conversation and note IDs and need full note information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | string | Yes | Unique ID of the note to retrieve |
| `conversation_id` | string | Yes | Unique ID of the conversation containing the note |

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

**Slug:** `HELPWISE_GET_NOTES`

Retrieves all notes associated with a specific conversation. Notes are internal comments or annotations that team members add to conversations for collaboration and context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | Unique identifier of the conversation. Obtain this from conversation listing or creation endpoints. |

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

**Slug:** `HELPWISE_GET_TAG`

Retrieves detailed information about a specific tag in Helpwise. Use this action when you need to: - Get the full properties of a tag including its name, color, and timestamps - Verify that a tag exists before performing operations on it - Retrieve tag details for display or processing Tags in Helpwise are labels that can be applied to conversations for organization and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | The unique identifier of the tag to retrieve. This ID is returned when listing tags or can be found in tag-related responses from other endpoints. |

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

**Slug:** `HELPWISE_GET_TEAM`

Retrieves details of a specific Helpwise team by its ID. Note: Team endpoints may not be available in all Helpwise API plans. If this action returns a 404 error, teams may need to be managed through the Helpwise web interface. Use this tool when you have a valid team_id and need to fetch team details such as name and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | Unique identifier of the Helpwise team 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 |

### Get Helpwise Teams

**Slug:** `HELPWISE_GET_TEAMS`

Tool to retrieve Helpwise teams. Use when you need to list and paginate all teams for assignment or management.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to fetch, must be 1 or greater |
| `per_page` | integer | No | Number of teams per page, maximum 100 |

#### 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 Helpwise WhatsApp Templates

**Slug:** `HELPWISE_GET_TEMPLATES`

Tool to retrieve Helpwise WhatsApp message templates. Use when you need to list WhatsApp templates for a mailbox or account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mailbox_id` | integer | No | WhatsApp mailbox ID to fetch templates for. If not provided, will attempt to fetch from any available mailbox. |

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

**Slug:** `HELPWISE_GET_USERS`

Tool to retrieve Helpwise users list. Use when you need to fetch and paginate agents for assignment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to fetch, must be >= 1 |
| `per_page` | integer | No | Number of users per page, must be >= 1 |

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

**Slug:** `HELPWISE_GET_WEBHOOK`

Retrieve detailed configuration for a specific Helpwise webhook by its ID. Use this action when you: - Need to inspect the configuration of an existing webhook - Want to verify webhook settings (URL, events, active status) - Need to check webhook creation/update timestamps Prerequisites: You must have a valid webhook ID, which can be obtained from the 'Get Webhooks' action or when creating a webhook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | The unique identifier of the webhook to retrieve. This is typically a numeric ID (e.g., '123') returned when creating a webhook or from the list webhooks endpoint. |

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

**Slug:** `HELPWISE_GET_WEBHOOKS`

Tool to retrieve Helpwise webhooks. Use when you need to list and paginate all webhook configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to fetch, must be 1 or greater |
| `per_page` | integer | No | Number of webhooks per page, maximum 100 |

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

### Search Helpwise Contacts

**Slug:** `HELPWISE_SEARCH_CONTACTS`

Tool to search contacts by term with pagination. Use when you need to find contacts by name, email, phone, or other contact attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `term` | string | Yes | Search term to find contacts by name, email, phone, or other contact fields |
| `limit` | integer | No | Number of results per page (1-100) |
| `offset` | integer | No | Offset for pagination (starting from 0) |

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

**Slug:** `HELPWISE_UPDATE_CONTACT`

Tool to update an existing Helpwise contact. Use when you need to modify contact details or custom attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Full name of the contact |
| `email` | string | No | Email address of the contact |
| `phone` | string | No | Phone number of the contact |
| `contact_id` | string | Yes | The unique identifier of the contact to update |
| `organization` | string | No | Organization or company name of the contact |
| `custom_attributes` | object | No | A dictionary of custom key-value attributes for the contact |

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

**Slug:** `HELPWISE_UPDATE_MAILBOX`

Updates an existing Helpwise mailbox. Use this action to modify mailbox settings such as display name, email address, team assignment, email signature, or default status. At least one field must be provided for update. Obtain the mailbox_id from the Get Mailboxes action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New display name for the mailbox. If provided, updates the mailbox's visible name. |
| `address` | string | No | Email address associated with the mailbox. Updates the email address used for this mailbox. |
| `team_id` | string | No | Team ID to assign this mailbox to. Use the Get Teams action to retrieve valid team IDs. |
| `signature` | string | No | Email signature to append to outgoing emails from this mailbox. Supports multi-line text. |
| `is_default` | boolean | No | Set to true to make this the default mailbox for sending emails, or false to remove default status. |
| `mailbox_id` | string | Yes | Unique identifier of the mailbox to update. Can be obtained from the Get Mailboxes 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 |

### Update Helpwise Message

**Slug:** `HELPWISE_UPDATE_MESSAGE`

Tool to update an existing message. Use when you need to modify message content by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Updated content of the message |
| `message_id` | string | Yes | Unique identifier of the message to update |

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

**Slug:** `HELPWISE_UPDATE_TAG`

Updates an existing tag's name and/or color in Helpwise. Use this action when you need to rename a tag or change its visual appearance. You must have the tag's ID before calling this action - obtain it using HELPWISE_GET_TAG or from the Helpwise UI.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Updated name for the tag. This will replace the existing tag name. |
| `color` | string | No | Optional hex color code for the tag (e.g., #FF0000 for red, #00FF00 for green). If not provided, the existing color will be preserved. |
| `tag_id` | string | Yes | Unique identifier of the tag to update. Obtain this from HELPWISE_GET_TAG or by listing tags through the Helpwise UI. |

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

**Slug:** `HELPWISE_UPDATE_TEMPLATE`

Updates an existing Helpwise email template by modifying its name, subject, and/or HTML content. Use this action when you need to: - Change the display name of a template - Update the subject line (including placeholders) - Modify the HTML content/body of the template Prerequisites: - You must have the template_id (obtain via Get Templates action or Helpwise UI) - At least one field (name, subject, or html) must be provided for update Note: This action performs a partial update - only provided fields will be modified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | No | Updated HTML content/body of the template. Supports placeholders like {{variable_name}}. If not provided, the existing content will remain unchanged. |
| `name` | string | No | New display name for the template. If not provided, the existing name will remain unchanged. |
| `subject` | string | No | New subject line for emails sent using this template. Supports placeholders like {{customer_name}}. If not provided, the existing subject will remain unchanged. |
| `template_id` | string | Yes | Unique identifier of the template to update. Obtain this from the Get Templates action or from the Helpwise UI. |

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