Zixflow
zixflowAI-CRM and Messaging Across SMS, Email, and WhatsApp
Acciones disponibles (7)
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 AttributeZIXFLOW_CREATE_ATTRIBUTEAcciónTool to create a custom attribute for a Zixflow collection or list. Use when you need to add new fields to track specific data types (text, number, email, etc.). Attributes define the structure of your data. Common use cases: adding custom fields for contacts, creating status trackers, adding reference fields between collections.
ZIXFLOW_CREATE_ATTRIBUTEAcciónTool to create a custom attribute for a Zixflow collection or list. Use when you need to add new fields to track specific data types (text, number, email, etc.). Attributes define the structure of your data. Common use cases: adding custom fields for contacts, creating status trackers, adding reference fields between collections.
Parámetros de entrada
namestringObligatorioHuman-readable display name shown in the UI. Can contain spaces and special characters
configobjectObligatorioConfiguration object with settings specific to the inputType. Required fields vary by inputType (e.g., currency requires currencyCode)
targetstringObligatorioenumType specification: either 'collection' or 'list' where the attribute will be created
collectionlistisUniquebooleanWhether this attribute's value must be unique across all records in the target. Useful for identifiers like email or account ID
targetIdstringObligatorioUnique identifier (MongoDB ObjectId format) for the target collection or list
inputTypestringObligatorioenumField type that determines how data is stored and displayed. Choose based on the data you want to store
textnumbercheckboxcurrencydatetimestampratingstatusselectmultiselectrecord-referenceactor-reference+5apiKeyNamestringObligatorioAPI key identifier used for data storage and retrieval. Must be unique within the target. Use lowercase with underscores for consistency (e.g., 'test_field', 'customer_email')
isEditablebooleanWhether users can modify this attribute's value after creation. Set to False for system-managed fields
isRequiredbooleanWhether this attribute must have a value when creating new records. Required fields prevent record creation if empty
descriptionstringDetailed description of the attribute's purpose and usage, visible to users
defaultValuestringDefault value assigned to this attribute when creating new records. Format depends on inputType
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WhatsApp Campaign ReportZIXFLOW_GET_CAMPAIGN_REPORT_WHATSAPPAcciónTool to retrieve WhatsApp campaign message report. Use when you need to check the delivery status and details of a WhatsApp message sent via campaign.
ZIXFLOW_GET_CAMPAIGN_REPORT_WHATSAPPAcciónTool to retrieve WhatsApp campaign message report. Use when you need to check the delivery status and details of a WhatsApp message sent via campaign.
Parámetros de entrada
message_idstringObligatorioThe message ID received when sending the WhatsApp campaign
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Email ReportZIXFLOW_GET_EMAIL_REPORTAcciónTool to retrieve email message delivery report from Zixflow. Use when you need to check the delivery status of a sent campaign email. The report includes delivery status (SENT, OPENED, CLICKED, BOUNCE, COMPLAINT, UNSUBSCRIBED), recipient information, and timestamps. Requires the message ID obtained when sending the campaign.
ZIXFLOW_GET_EMAIL_REPORTAcciónTool to retrieve email message delivery report from Zixflow. Use when you need to check the delivery status of a sent campaign email. The report includes delivery status (SENT, OPENED, CLICKED, BOUNCE, COMPLAINT, UNSUBSCRIBED), recipient information, and timestamps. Requires the message ID obtained when sending the campaign.
Parámetros de entrada
message_idstringObligatorioThe unique message ID that was received when sending the campaign. This is typically a 24-character MongoDB ObjectId format (hexadecimal string).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS ReportZIXFLOW_GET_SMS_REPORTAcciónTool to retrieve SMS message delivery report from Zixflow. Use when you need to check the delivery status, destination, and other details of a sent SMS campaign message.
ZIXFLOW_GET_SMS_REPORTAcciónTool to retrieve SMS message delivery report from Zixflow. Use when you need to check the delivery status, destination, and other details of a sent SMS campaign message.
Parámetros de entrada
messageIdstringObligatorioThe message ID that you received when sending the campaign
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WhatsApp Template VariablesZIXFLOW_GET_WHATSAPP_TEMPLATE_VARIABLESAcciónTool to retrieve template variable details for a WhatsApp template. Use when you need to understand what variables a specific WhatsApp template expects before sending a message.
ZIXFLOW_GET_WHATSAPP_TEMPLATE_VARIABLESAcciónTool to retrieve template variable details for a WhatsApp template. Use when you need to understand what variables a specific WhatsApp template expects before sending a message.
Parámetros de entrada
phoneIdstringObligatorioUnique identifier associated with the sender's phone number
languagestringObligatorioLanguage code for the template (e.g., 'en' for English, 'es' for Spanish)
templateNamestringObligatorioName of the WhatsApp template to retrieve variables for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Attribute OptionsZIXFLOW_LIST_ATTRIBUTES_OPTIONSAcciónTool to retrieve the list of options for select/multiselect attributes. Use when you need to get available options for a specific attribute in a collection or list.
ZIXFLOW_LIST_ATTRIBUTES_OPTIONSAcciónTool to retrieve the list of options for select/multiselect attributes. Use when you need to get available options for a specific attribute in a collection or list.
Parámetros de entrada
targetstringObligatorioenumSpecifies the target type, which can be either 'collection' or 'list.'
collectionlisttargetIdstringObligatorioUnique identifier for the target (collection ID or list ID)
attributeIdstringObligatorioID of the select or multiselect attribute
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Attribute Status OptionsZIXFLOW_LIST_ATTRIBUTES_STATUSAcciónTool to retrieve the list of options for status attributes in Zixflow. Use when you need to fetch available status configurations for a specific attribute within a collection or list.
ZIXFLOW_LIST_ATTRIBUTES_STATUSAcciónTool to retrieve the list of options for status attributes in Zixflow. Use when you need to fetch available status configurations for a specific attribute within a collection or list.
Parámetros de entrada
targetstringObligatorioenumSpecifies the target type, which can be either 'collection' or 'list'
collectionlisttargetIdstringObligatorioUnique identifier for the target (collection ID or list ID)
attributeIdstringObligatorioID of the status attribute
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not