Skip to main content
Retently logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 15
  • Triggers: 0
  • Slug: RETENTLY
  • Version: 20261101_00

Tools

Slug: RETENTLY_ADD_FEEDBACK_TAGSAdd or replace tags on a single feedback response by its ID. By default existing tags are replaced; choose append to retain them.

Input Parameters

string
required
The ID of the feedback response.
string
Use the flag “append” in order to append the tags to the response, or leave it empty in order to override existing tags.
array
required
An array of tags to be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RETENTLY_ADD_FEEDBACK_TOPICSAdd or replace topics on a single feedback response by its ID. By default existing topics are replaced; choose append to retain them.

Input Parameters

array
required
A list of topics to add to the feedback.
string ("append" | "override")
Use ‘append’ to add to existing topics, or ‘override’ to replace them.
string
required
The ID of the feedback to add topics to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
A list of customer objects to be created or updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RETENTLY_DELETE_CUSTOMERSDelete customers from the workspace by providing their email addresses.

Input Parameters

array
required
A list of customer objects to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RETENTLY_GET_CAMPAIGNSTool to retrieve a list of campaigns associated with the account. Use when you need to get details about all campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the customer to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RETENTLY_GET_CUSTOMERSRetrieve a list of customers with optional parameters for pagination, sorting, and filtering by email or date range.

Input Parameters

integer
The current page number. Default 1;
string
The sort option. Use ‘-’ for DESC. Default ‘-createdDate’;
string
Find a customer by the email address.
integer
The items limit. Default 20;
string
ISO format or UNIX timestamp;
string
ISO format or UNIX timestamp;

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The current page number. Default 1
string
The sort option. Use ‘-’ for DESC. Default ‘-createdDate’
string
Search responses by a customer’s email address
integer
The items limit. Default 20
string
The end date for the feedback, in UNIX timestamp format.
string
The start date for the feedback, in UNIX timestamp format.
string
Filter responses by a specific campaign ID
string
Search responses by a customer’s Retently ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the feedback to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RETENTLY_GET_OUTBOXRetrieve a paginated outbox of sent surveys, with optional email filtering and sorting.

Input Parameters

integer
The current page number.
string
The sort option. Use -surveyCreatedDate for results in descending order.
string
Find a customer’s outbox records by email address.
integer
The number of items per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The end date for the report in YYYY-MM-DD format.
string
The start date for the report in YYYY-MM-DD format.
string
The ID of the campaign to get reports for. If not provided, reports for all campaigns will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The delay in days to send the survey after the triggered event.
string
required
The ID of the campaign where the customers will be surveyed.
array
required
A list of customers to send the survey to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RETENTLY_UNSUBSCRIBE_CUSTOMERSUnsubscribe customers from receiving surveys by providing their email addresses.

Input Parameters

string
Opt out message.
array
required
An array of subscriber emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not