> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Heyy

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

![Heyy logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/heyy.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=d14b72af1c03594f35cf404d58d06a4c)

* **Category:** communication
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 13
* **Triggers:** 0
* **Slug:** `HEYY`
* **Version:** 20260615\_00

## Tools

> [accordion] 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
>
> **name** `string` *required*
>
> Name of the attribute to create. This will be displayed in the UI.
>
> **externalId** `string` *required*
>
> 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`
>
> Optional description providing details about the attribute's purpose and usage.
>
> **isVisibleQuickEdit** `boolean`
>
> Whether this attribute should be visible in the quick edit panel. Defaults to false if not specified.
>
> **isVisibleContactCreate** `boolean`
>
> Whether this attribute should be visible when creating a new contact. Defaults to false if not specified.
>
> **isVisibleContactsTable** `boolean`
>
> Whether this attribute should be visible in the contacts table view. Defaults to false if not specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **email** `string`
>
> Email address of the contact. Must be a valid email format if provided.
>
> **labels** `array`
>
> List of labels to assign to the contact
>
> **lastName** `string`
>
> Last name of the contact
>
> **firstName** `string`
>
> First name of the contact
>
> **attributes** `array`
>
> List of custom attributes to attach to the contact
>
> **phoneNumber** `string`
>
> Phone number of the contact
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> The name of the label to create. Used for categorizing contacts. Must be a non-empty string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **url** `string` *required*
>
> 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")` *required*
>
> Type of event notification to receive. Determines which events trigger webhook calls
>
> **tenant\_id** `string` *required*
>
> Tenant identifier for the webhook. Required to associate the webhook with your tenant
>
> **channel\_id** `string`
>
> Optional channel identifier to filter webhook events to a specific channel. If not provided, webhook receives events from all channels
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **attribute\_id** `string` *required*
>
> Unique identifier of the attribute to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **label\_id** `string` *required*
>
> Unique identifier of the label to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **webhook\_id** `string` *required*
>
> Unique identifier of the webhook to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **channel\_id** `string` *required*
>
> The unique identifier of the channel for which to retrieve automation workflows
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **url** `string`
>
> The new webhook URL to receive POST requests. Must be a valid HTTPS endpoint.
>
> **is\_active** `boolean`
>
> Whether the webhook is active. Set to true to enable or false to disable webhook notifications.
>
> **webhook\_id** `string` *required*
>
> The unique identifier of the webhook to update (UUID format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
