Skip to main content
Heyy logo
  • Category: communication
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: HEYY
  • Version: 20260615_00

Tools

Slug: HEYY_CREATE_ATTRIBUTETool 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

string
required
Name of the attribute to create. This will be displayed in the UI.
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.
string
Optional description providing details about the attribute’s purpose and usage.
boolean
Whether this attribute should be visible in the quick edit panel. Defaults to false if not specified.
boolean
Whether this attribute should be visible when creating a new contact. Defaults to false if not specified.
boolean
Whether this attribute should be visible in the contacts table view. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_CREATE_CONTACTTool 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

string
Email address of the contact. Must be a valid email format if provided.
array
List of labels to assign to the contact
string
Last name of the contact
string
First name of the contact
array
List of custom attributes to attach to the contact
string
Phone number of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_CREATE_LABELTool to create a new label for categorizing contacts in Heyy. Use when you need to organize contacts into categories or groups.

Input Parameters

string
required
The name of the label to create. Used for categorizing contacts. Must be a non-empty string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_CREATE_WEBHOOKTool 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

string
required
HTTPS endpoint URL where webhook events will be sent. Must be a valid, publicly accessible URL
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
string
required
Tenant identifier for the webhook. Required to associate the webhook with your tenant
string
Optional channel identifier to filter webhook events to a specific channel. If not provided, webhook receives events from all channels

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_DELETE_ATTRIBUTETool to delete an attribute by its unique identifier. Use when you need to remove an attribute from the system.

Input Parameters

string
required
Unique identifier of the attribute to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_DELETE_LABELTool to delete a label by its unique identifier. Use when you need to remove a label from the system.

Input Parameters

string
required
Unique identifier of the label to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_DELETE_WEBHOOKTool to delete a webhook by its unique identifier. Use when you need to remove a webhook from Heyy.

Input Parameters

string
required
Unique identifier of the webhook to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_LIST_ATTRIBUTESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_LIST_AUTOMATIONSTool to retrieve automation workflows for a specified channel. Use when you need to get all workflows configured for a channel.

Input Parameters

string
required
The unique identifier of the channel for which to retrieve automation workflows

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_LIST_CHANNELSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_LIST_MESSAGE_TEMPLATESTool to retrieve all message templates available in the Heyy system. Use when you need to view all existing templates for messaging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_LIST_WEBHOOKSTool to retrieve all API webhooks configured for the account. Use when you need to inspect or manage webhook configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYY_UPDATE_WEBHOOKTool 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

string
The new webhook URL to receive POST requests. Must be a valid HTTPS endpoint.
boolean
Whether the webhook is active. Set to true to enable or false to disable webhook notifications.
string
required
The unique identifier of the webhook to update (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not