NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Heyy

heyy

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

CommunicationMarketing AutomationWeb del proveedor
Acciones
13
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (13)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Contact AttributeHEYY_CREATE_ATTRIBUTEAcción

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.

Parámetros de entrada

  • namestringObligatorio

    Name of the attribute to create. This will be displayed in the UI.

  • externalIdstringObligatorio

    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.

  • descriptionstring

    Optional description providing details about the attribute's purpose and usage.

  • isVisibleQuickEditboolean

    Whether this attribute should be visible in the quick edit panel. Defaults to false if not specified.

  • isVisibleContactCreateboolean

    Whether this attribute should be visible when creating a new contact. Defaults to false if not specified.

  • isVisibleContactsTableboolean

    Whether this attribute should be visible in the contacts table view. Defaults to false if not specified.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ContactHEYY_CREATE_CONTACTAcción

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.

Parámetros de entrada

  • emailstring

    Email address of the contact. Must be a valid email format if provided.

  • labelsobject[]

    List of labels to assign to the contact

  • lastNamestring

    Last name of the contact

  • firstNamestring

    First name of the contact

  • attributesobject[]

    List of custom attributes to attach to the contact

  • phoneNumberstring

    Phone number of the contact

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create LabelHEYY_CREATE_LABELAcción

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

Parámetros de entrada

  • namestringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create WebhookHEYY_CREATE_WEBHOOKAcción

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.

Parámetros de entrada

  • urlstringObligatorio

    HTTPS endpoint URL where webhook events will be sent. Must be a valid, publicly accessible URL

  • typestringObligatorioenum

    Type of event notification to receive. Determines which events trigger webhook calls

    WHATSAPP_MESSAGE_RECEIVEDWHATSAPP_MESSAGE_STATUSSMS_MESSAGE_RECEIVEDSMS_MESSAGE_STATUSEMAIL_MESSAGE_RECEIVEDEMAIL_MESSAGE_STATUSINSTAGRAM_MESSAGE_RECEIVEDINSTAGRAM_MESSAGE_STATUSINSTAGRAM_MESSAGE_ECHO
  • tenant_idstringObligatorio

    Tenant identifier for the webhook. Required to associate the webhook with your tenant

  • channel_idstring

    Optional channel identifier to filter webhook events to a specific channel. If not provided, webhook receives events from all channels

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete AttributeHEYY_DELETE_ATTRIBUTEAcción

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

Parámetros de entrada

  • attribute_idstringObligatorio

    Unique identifier of the attribute to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete LabelHEYY_DELETE_LABELAcción

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

Parámetros de entrada

  • label_idstringObligatorio

    Unique identifier of the label to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookHEYY_DELETE_WEBHOOKAcción

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

Parámetros de entrada

  • webhook_idstringObligatorio

    Unique identifier of the webhook to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List AttributesHEYY_LIST_ATTRIBUTESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List AutomationsHEYY_LIST_AUTOMATIONSAcción

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

Parámetros de entrada

  • channel_idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ChannelsHEYY_LIST_CHANNELSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Message TemplatesHEYY_LIST_MESSAGE_TEMPLATESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List API WebhooksHEYY_LIST_WEBHOOKSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update WebhookHEYY_UPDATE_WEBHOOKAcción

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.

Parámetros de entrada

  • urlstring

    The new webhook URL to receive POST requests. Must be a valid HTTPS endpoint.

  • is_activeboolean

    Whether the webhook is active. Set to true to enable or false to disable webhook notifications.

  • webhook_idstringObligatorio

    The unique identifier of the webhook to update (UUID format)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not