NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Retently connects to a Nagent workspace with an API key. Once it is connected, agents can call 15 Retently actions, such as "Add Feedback Tags", "Add Feedback Topics" and "Create or Update Customers". 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 Retently, with input parameters and output schema.
RETENTLY_ADD_FEEDBACK_TAGSAdd tags to feedback items by providing feedback IDs and corresponding tags.
Input parameters
The ID of the feedback response.
Use the flag “append” in order to append the tags to the response, or leave it empty in order to override existing tags.
An array of tags to be added.
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
RETENTLY_ADD_FEEDBACK_TOPICSAdd topics to feedback items by providing feedback IDs and corresponding topics.
Input parameters
A list of topics to add to the feedback.
Use 'append' to add to existing topics, or 'override' to replace them.
The ID of the feedback to add topics to.
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
RETENTLY_CREATE_OR_UPDATE_CUSTOMERSTool to create new customers or update existing ones by providing their details, including email, name, company, tags, and properties. Use this to manage your customer base in Retently.
Input parameters
A list of customer objects to be created or updated.
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
RETENTLY_DELETE_CUSTOMERSDelete customers from the workspace by providing their unique IDs.
Input parameters
A list of customer objects 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
RETENTLY_GET_CAMPAIGNSTool to retrieve a list of campaigns associated with the account. Use when you need to get details about all campaigns.
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
RETENTLY_GET_CUSTOMER_BY_IDTool to retrieve detailed information about a specific customer by their unique ID. Use when you need to get all the details of a customer.
Input parameters
The ID of the customer to retrieve.
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
RETENTLY_GET_CUSTOMERSRetrieve a list of customers with optional parameters for pagination, sorting, and filtering by email or date range.
Input parameters
The current page number. Default 1;
The sort option. Use ‘-’ for DESC. Default ‘-createdDate’;
Find a customer by the email address.
The items limit. Default 20;
ISO format or UNIX timestamp;
ISO format or UNIX timestamp;
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
RETENTLY_GET_FEEDBACKTool to retrieve feedback received from customers. Use when you need to get a list of feedback, with optional parameters for pagination and sorting.
Input parameters
The current page number. Default 1
The sort option. Use ‘-’ for DESC. Default ‘-createdDate’
Search responses by a customer’s email address
The items limit. Default 20
The end date for the feedback, in UNIX timestamp format.
The start date for the feedback, in UNIX timestamp format.
Filter responses by a specific campaign ID
Search responses by a customer’s Retently ID
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
RETENTLY_GET_FEEDBACK_BY_IDTool to retrieve detailed information about specific feedback by its unique ID. Use when you need to get the details of a single feedback entry.
Input parameters
The unique identifier of the feedback to be retrieved.
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
RETENTLY_GET_LATEST_SCORETool to retrieve the latest NPS score for the account. Use when you need to get the most up-to-date NPS score.
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
RETENTLY_GET_OUTBOXRetrieve the outbox of surveys that are scheduled to be sent.
Input parameters
The current page number.
The sort option. Use -surveyCreatedDate for results in descending order.
Find a customer’s outbox records by email address.
The number of items per page.
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
RETENTLY_GET_REPORTSTool to retrieve reports related to NPS surveys, including scores and trends. Use when you need to get campaign performance data.
Input parameters
The end date for the report in YYYY-MM-DD format.
The start date for the report in YYYY-MM-DD format.
The ID of the campaign to get reports for. If not provided, reports for all campaigns will be returned.
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
RETENTLY_GET_TEMPLATESTool to retrieve a list of survey templates available in the account. Use when you need to get the available survey templates.
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
RETENTLY_SEND_TRANSACTIONAL_SURVEYTool to send a transactional survey to customers. Use when you need to send a survey to a customer after a specific event, with an optional delay.
Input parameters
The delay in days to send the survey after the triggered event.
The ID of the campaign where the customers will be surveyed.
A list of customers to send the survey to.
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
RETENTLY_UNSUBSCRIBE_CUSTOMERSUnsubscribe customers from receiving surveys by providing their email addresses.
Input parameters
Opt out message.
An array of subscriber emails.
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 15 Retently actions on Nagent, including "Add Feedback Tags", "Add Feedback Topics" and "Create or Update Customers". Add Feedback Tags: Add tags to feedback items by providing feedback IDs and corresponding tags. Each action is listed on this page with its input parameters and its output.
Retently 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.
Add Feedback Tags takes 2 required inputs: id and tags. It also takes 1 optional input: op. It returns data, error and successful.