trigger_workflow
Trigger Workflow
Trigger an automation workflow for a specific phone number on a channel. Optionally provide template variables and schedule the execution for a future time.
trigger_workflow
Trigger an automation workflow for a specific phone number on a channel. Optionally provide template variables and schedule the execution for a future time.
update_chat
Update a chat's properties including status, read state, and assignment. Use this to close or reopen chats, mark them as read/unread, or assign them to team members.
send_whatsapp_message
Send a WhatsApp message to a contact through a specified channel. Supports text messages, template messages, and media messages (image, video, document, audio). For **text** messages, provide the body text directly. For **template** messages, provide a message template ID and optional variables. For **media** messages, provide a file ID obtained from the file upload tool. Messages can optionally be scheduled for future delivery.
list_workflows
List all automation workflows available on a specific channel. Returns workflow IDs and details that can be used to trigger automations or associate with broadcasts.
create_broadcast
Create a new broadcast campaign on a channel. Broadcasts allow you to send messages to many contacts at once for marketing outreach or re-engagement. You can schedule broadcasts, set recurrence, and include template variables.
delete_contact
Permanently delete a contact from your Heyy business account. This removes the contact and all associated data.
list_chats
List all chats on a specific channel. Returns chat IDs, statuses, contact associations, assignment details, and message timestamps. Use this to find ongoing conversations.
list_message_templates
List all available WhatsApp message templates. Templates are Meta-approved message formats required for initiating WhatsApp conversations. Returns template IDs, names, statuses, categories, languages, and components. Use template IDs when sending template messages.
start_broadcast
Start a previously created broadcast campaign. Requires a media ID that was uploaded via the file upload tool. Once started, the broadcast will begin sending messages to its recipients.
add_broadcast_recipients
Add contacts as recipients to a broadcast campaign. Provide an array of contact IDs to add to the broadcast's recipient list.
get_business_info
Retrieve details about your Heyy business account. Returns the business name, email, phone number, address, and other account-level configuration. Useful for verifying API connectivity and fetching business metadata.
list_broadcasts
List all broadcast campaigns on a specific channel. Returns broadcast IDs, names, statuses, schedules, and workflow associations.
create_contact
Create a new contact in your Heyy business account. Contacts represent customers or leads that you communicate with across channels. You can set names, email, phone number, labels, and custom attributes.
list_channels
List all connected messaging channels in your Heyy business account. Returns channel IDs, names, types (WhatsApp, Instagram, Facebook Messenger, Live Chat), and statuses. Channel IDs are required for sending messages, managing chats, broadcasts, and workflows.
list_contacts
List and search contacts in your Heyy business account. Supports pagination, sorting, and search filtering. Returns contact details including names, phone numbers, emails, labels, and custom attributes.
update_contact
Update an existing contact's details in your Heyy business account. You can modify names, labels, and custom attributes. Note that email and phone number cannot be changed after creation.
Send messages to contacts across WhatsApp, Instagram, Facebook Messenger, and website live chat from a unified inbox. Create and update contacts, upload files for conversations, retrieve business account information, and run marketing campaigns. Receive webhook notifications for incoming messages across all connected channels. Supports AI-powered customer support, lead qualification, and automated conversation workflows.
Common questions about connecting Heyy to AI agents with Metorial.