Helpdesk
helpdeskHelpDesk is a ticketing system designed to streamline customer support by organizing and managing inquiries efficiently.
Acciones disponibles (15)
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.
List AgentsHELPDESK_LIST_AGENTSAcciónTool to list agents. Use when you need to retrieve all agents on the account.
HELPDESK_LIST_AGENTSAcciónTool to list agents. Use when you need to retrieve all agents on the account.
Parámetros de entrada
Sin parámetros.
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 Canned ResponsesHELPDESK_LIST_CANNED_RESPONSESAcciónTool to list canned responses. Use when you need to retrieve all predefined reply templates for tickets.
HELPDESK_LIST_CANNED_RESPONSESAcciónTool to list canned responses. Use when you need to retrieve all predefined reply templates for tickets.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData 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 ContactsHELPDESK_LIST_CONTACTSAcciónTool to list contacts. Use when you need to retrieve contacts with optional filters and pagination.
HELPDESK_LIST_CONTACTSAcciónTool to list contacts. Use when you need to retrieve contacts with optional filters and pagination.
Parámetros de entrada
pageintegerPage number for results (starting at 1)
emailstringFilter by primary email (URL-encoded)
phonestringFilter by phone number (URL-encoded)
statestringenumFilter by contact state: blocked | deleted | unverified | verified
blockeddeletedunverifiedverifiedmobilestringFilter by mobile number (URL-encoded)
per_pageintegerNumber of contacts per page (max 100)
company_idintegerFilter by primary company ID
updated_sincestringdate-timeReturn contacts updated after this timestamp (ISO 8601 UTC)
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 Custom FieldsHELPDESK_LIST_CUSTOM_FIELDSAcciónTool to list all custom fields defined in the account. Use when you need to view or manage custom fields. Only callable after authentication.
HELPDESK_LIST_CUSTOM_FIELDSAcciónTool to list all custom fields defined in the account. Use when you need to view or manage custom fields. Only callable after authentication.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData 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 Email DomainsHELPDESK_LIST_EMAIL_DOMAINSAcciónTool to list email domains configured for the account. Use when you need to retrieve all configured email domains after authenticating.
HELPDESK_LIST_EMAIL_DOMAINSAcciónTool to list email domains configured for the account. Use when you need to retrieve all configured email domains after authenticating.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData 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 LicensesHELPDESK_LIST_LICENSESAcciónTool to list all licenses for an account. Use when you need to retrieve license configurations.
HELPDESK_LIST_LICENSESAcciónTool to list all licenses for an account. Use when you need to retrieve license configurations.
Parámetros de entrada
Sin parámetros.
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 Reply AddressesHELPDESK_LIST_REPLY_ADDRESSESAcciónTool to retrieve reply addresses. Use when you need to fetch all configured reply email addresses.
HELPDESK_LIST_REPLY_ADDRESSESAcciónTool to retrieve reply addresses. Use when you need to fetch all configured reply email addresses.
Parámetros de entrada
Sin parámetros.
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 RulesHELPDESK_LIST_RULESAcciónTool to retrieve a list of rules configured in the account. Use after authentication when you need an overview of all automation rules.
HELPDESK_LIST_RULESAcciónTool to retrieve a list of rules configured in the account. Use after authentication when you need an overview of all automation rules.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData 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 SubscriptionsHELPDESK_LIST_SUBSCRIPTIONSAcciónTool to list subscriptions. Use when you need to retrieve current or historical subscription details.
HELPDESK_LIST_SUBSCRIPTIONSAcciónTool to list subscriptions. Use when you need to retrieve current or historical subscription details.
Parámetros de entrada
statestringenumFilter by subscription state. Allowed values: active, expired, canceled, future, pending.
activeexpiredcanceledfuturependingplanCodes[]string[]Filter by one or more plan codes. Allowed values: hd-team1m, hd-team3m, hd-team12m, hd-team36m, hd-enterprise1m, hd-enterprise3m, hd-enterprise6m, hd-enterprise12m, hd-enterprise24m, hd-enterprise36m.
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 TeamsHELPDESK_LIST_TEAMSAcciónTool to list all teams for the authenticated Helpdesk account. Use after providing valid credentials to retrieve team IDs, names, and settings. Example: "List all teams".
HELPDESK_LIST_TEAMSAcciónTool to list all teams for the authenticated Helpdesk account. Use after providing valid credentials to retrieve team IDs, names, and settings. Example: "List all teams".
Parámetros de entrada
Sin parámetros.
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 TicketsHELPDESK_LIST_TICKETSAcciónTool to list tickets with cursor-based pagination. Use when you need to fetch multiple pages of tickets after setting your cursor and sort parameters.
HELPDESK_LIST_TICKETSAcciónTool to list tickets with cursor-based pagination. Use when you need to fetch multiple pages of tickets after setting your cursor and sort parameters.
Parámetros de entrada
orderstringenumSort direction (asc or desc).
ascdescsortBystringenumField to sort by.
createdAtupdatedAtlastMessageAtnext.IDstringID of last item on current page (forward cursor).
prev.IDstringID of first item on current page (backward cursor).
pageSizeintegerNumber of results per page (1-100).
next.valuestringdate-timeTimestamp of last item on current page (forward cursor).
prev.valuestringdate-timeTimestamp of first item on current page (backward cursor).
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 Trusted EmailsHELPDESK_LIST_TRUSTED_EMAILSAcciónTool to retrieve a list of trusted email addresses or domains. Use when managing your spam whitelist after authenticating.
HELPDESK_LIST_TRUSTED_EMAILSAcciónTool to retrieve a list of trusted email addresses or domains. Use when managing your spam whitelist after authenticating.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData 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 ViewsHELPDESK_LIST_VIEWSAcciónTool to list agent views. Use when you need to retrieve saved ticket views after authentication.
HELPDESK_LIST_VIEWSAcciónTool to list agent views. Use when you need to retrieve saved ticket views after authentication.
Parámetros de entrada
Sin parámetros.
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 WebhooksHELPDESK_LIST_WEBHOOKSAcciónTool to list all webhooks configured for events. Use when you need to retrieve webhook configurations for an account.
HELPDESK_LIST_WEBHOOKSAcciónTool to list all webhooks configured for events. Use when you need to retrieve webhook configurations for an account.
Parámetros de entrada
Sin parámetros.
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
View AgentHELPDESK_VIEW_AGENTAcciónTool to retrieve details of a specific agent (v1). Use after confirming agent ID.
HELPDESK_VIEW_AGENTAcciónTool to retrieve details of a specific agent (v1). Use after confirming agent ID.
Parámetros de entrada
agentIDstringObligatorioAgent ID (UUID) to retrieve.
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