# Heyy

Connect with your customers on Whatsapp, SMS, Messenger and Instagram using automation.

- **Category:** communication
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `HEYY`
- **Version:** 20260227_00

## Tools

### Create Contact Attribute

**Slug:** `HEYY_CREATE_ATTRIBUTE`

Tool to create a new custom attribute for contacts in Heyy. Use when you need to add custom fields to track additional information about contacts, such as customer segments, preferences, or custom identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the attribute to create. This will be displayed in the UI. |
| `externalId` | string | Yes | External identifier for the attribute. Must start with a letter and contain only letters, numbers, and underscores. This is used for API and integration purposes. |
| `description` | string | No | Optional description providing details about the attribute's purpose and usage. |
| `isVisibleQuickEdit` | boolean | No | Whether this attribute should be visible in the quick edit panel. Defaults to false if not specified. |
| `isVisibleContactCreate` | boolean | No | Whether this attribute should be visible when creating a new contact. Defaults to false if not specified. |
| `isVisibleContactsTable` | boolean | No | Whether this attribute should be visible in the contacts table view. Defaults to false if not specified. |

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

**Slug:** `HEYY_CREATE_CONTACT`

Tool to create a new contact in Heyy with optional details including first name, last name, email, phone number, labels, and custom attributes. Use when you need to add a new contact to your Heyy account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Email address of the contact. Must be a valid email format if provided. |
| `labels` | array | No | List of labels to assign to the contact |
| `lastName` | string | No | Last name of the contact |
| `firstName` | string | No | First name of the contact |
| `attributes` | array | No | List of custom attributes to attach to the contact |
| `phoneNumber` | string | No | Phone number of 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 |

### Create Label

**Slug:** `HEYY_CREATE_LABEL`

Tool to create a new label for categorizing contacts in Heyy. Use when you need to organize contacts into categories or groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the label to create. Used for categorizing contacts. Must be a non-empty string. |

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

**Slug:** `HEYY_CREATE_WEBHOOK`

Tool to create a new webhook for receiving event notifications across multiple channels. Use when you need to set up real-time event notifications for messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTPS endpoint URL where webhook events will be sent. Must be a valid, publicly accessible URL |
| `type` | string ("WHATSAPP_MESSAGE_RECEIVED" | "WHATSAPP_MESSAGE_STATUS" | "SMS_MESSAGE_RECEIVED" | "SMS_MESSAGE_STATUS" | "EMAIL_MESSAGE_RECEIVED" | "EMAIL_MESSAGE_STATUS" | "INSTAGRAM_MESSAGE_RECEIVED" | "INSTAGRAM_MESSAGE_STATUS" | "INSTAGRAM_MESSAGE_ECHO") | Yes | Type of event notification to receive. Determines which events trigger webhook calls |
| `tenant_id` | string | Yes | Tenant identifier for the webhook. Required to associate the webhook with your tenant |
| `channel_id` | string | No | Optional channel identifier to filter webhook events to a specific channel. If not provided, webhook receives events from all channels |

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

**Slug:** `HEYY_DELETE_ATTRIBUTE`

Tool to delete an attribute by its unique identifier. Use when you need to remove an attribute from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attribute_id` | string | Yes | Unique identifier of the attribute 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 Label

**Slug:** `HEYY_DELETE_LABEL`

Tool to delete a label by its unique identifier. Use when you need to remove a label from the system.

#### Input Parameters

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

**Slug:** `HEYY_DELETE_WEBHOOK`

Tool to delete a webhook by its unique identifier. Use when you need to remove a webhook from Heyy.

#### Input Parameters

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

### List Attributes

**Slug:** `HEYY_LIST_ATTRIBUTES`

Tool to retrieve all attributes available in the Heyy system. Use when you need to get a list of all attributes with their properties and visibility 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 |

### List Automations

**Slug:** `HEYY_LIST_AUTOMATIONS`

Tool to retrieve automation workflows for a specified channel. Use when you need to get all workflows configured for a channel.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | The unique identifier of the channel for which to retrieve automation 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 |

### List Channels

**Slug:** `HEYY_LIST_CHANNELS`

Tool to retrieve all available channels from the Heyy system. Use when you need to get a complete list of channels with their details including name, type, status, and timestamps.

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

**Slug:** `HEYY_LIST_MESSAGE_TEMPLATES`

Tool to retrieve all message templates available in the Heyy system. Use when you need to view all existing templates for messaging.

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

**Slug:** `HEYY_LIST_WEBHOOKS`

Tool to retrieve all API webhooks configured for the account. Use when you need to inspect or manage webhook configurations.

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

**Slug:** `HEYY_UPDATE_WEBHOOK`

Tool to update a webhook's URL and active status. Use when you need to modify an existing webhook's endpoint or enable/disable it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | The new webhook URL to receive POST requests. Must be a valid HTTPS endpoint. |
| `is_active` | boolean | No | Whether the webhook is active. Set to true to enable or false to disable webhook notifications. |
| `webhook_id` | string | Yes | The unique identifier of the webhook to update (UUID format) |

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