NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Heyy connects to a Nagent workspace with an API key. Once it is connected, agents can call 13 Heyy actions, such as "Create Contact Attribute", "Create Contact" and "Create Label". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Heyy, with input parameters and output schema.
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
Name of the attribute to create. This will be displayed in the UI.
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.
Optional description providing details about the attribute's purpose and usage.
Whether this attribute should be visible in the quick edit panel. Defaults to false if not specified.
Whether this attribute should be visible when creating a new contact. Defaults to false if not specified.
Whether this attribute should be visible in the contacts table view. Defaults to false if not specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Email address of the contact. Must be a valid email format if provided.
List of labels to assign to the contact
Last name of the contact
First name of the contact
List of custom attributes to attach to the contact
Phone number of the contact
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The name of the label to create. Used for categorizing contacts. Must be a non-empty string.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
HTTPS endpoint URL where webhook events will be sent. Must be a valid, publicly accessible URL
Type of event notification to receive. Determines which events trigger webhook calls
Tenant identifier for the webhook. Required to associate the webhook with your tenant
Optional channel identifier to filter webhook events to a specific channel. If not provided, webhook receives events from all channels
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYY_DELETE_ATTRIBUTETool to delete an attribute by its unique identifier. Use when you need to remove an attribute from the system.
Input parameters
Unique identifier of the attribute to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYY_DELETE_LABELTool to delete a label by its unique identifier. Use when you need to remove a label from the system.
Input parameters
Unique identifier of the label to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYY_DELETE_WEBHOOKTool to delete a webhook by its unique identifier. Use when you need to remove a webhook from Heyy.
Input parameters
Unique identifier of the webhook to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the channel for which to retrieve automation workflows
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
HEYY_LIST_WEBHOOKSTool to retrieve all API webhooks configured for the account. Use when you need to inspect or manage webhook configurations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The new webhook URL to receive POST requests. Must be a valid HTTPS endpoint.
Whether the webhook is active. Set to true to enable or false to disable webhook notifications.
The unique identifier of the webhook to update (UUID format)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 13 Heyy actions on Nagent, including "Create Contact Attribute", "Create Contact" and "Create Label". Create Contact Attribute: Create a new custom attribute for contacts in Heyy. Each action is listed on this page with its input parameters and its output.
Heyy connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Contact Attribute takes 2 required inputs: name and externalId. It also takes 4 optional inputs: description, isVisibleQuickEdit, isVisibleContactCreate and isVisibleContactsTable. It returns data, error and successful.