Retently

Learn how to use Retently with Composio

Overview

SLUG

RETENTLY

Description

Retently is a customer experience management platform that enables businesses to collect, analyze, and act on customer feedback through surveys and integrations.

Authentication Details

generic_api_key
stringRequired

Tools

SLUG: RETENTLY_ADD_FEEDBACK_TAGS

Add tags to feedback items by providing feedback ids and corresponding tags.

Action Parameters

id
stringRequired
op
string
tags
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: RETENTLY_ADD_FEEDBACK_TOPICS

Add topics to feedback items by providing feedback ids and corresponding topics.

Action Parameters

feedback_id
stringRequired
operation
stringDefaults to override
topics
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: RETENTLY_CREATE_OR_UPDATE_CUSTOMERS

Tool 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.

Action Parameters

subscribers
arrayRequired

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
successful
booleanRequired

SLUG: RETENTLY_DELETE_CUSTOMERS

Delete customers from the workspace by providing their unique ids.

Action Parameters

subscribers
arrayRequired

Action Response

code
integerRequired
data
arrayRequired
error
string
message
stringRequired
successful
booleanRequired

SLUG: RETENTLY_GET_CAMPAIGNS

Tool to retrieve a list of campaigns associated with the account. use when you need to get details about all campaigns.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: RETENTLY_GET_CUSTOMERS

Retrieve a list of customers with optional parameters for pagination, sorting, and filtering by email or date range.

Action Parameters

email
string
endDate
string
limit
integerDefaults to 20
page
integerDefaults to 1
sort
stringDefaults to -createdDate
startDate
string

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
successful
booleanRequired

SLUG: RETENTLY_GET_CUSTOMER_BY_ID

Tool to retrieve detailed information about a specific customer by their unique id. use when you need to get all the details of a customer.

Action Parameters

customer_id
stringRequired

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
successful
booleanRequired

SLUG: RETENTLY_GET_FEEDBACK

Tool to retrieve feedback received from customers. use when you need to get a list of feedback, with optional parameters for pagination and sorting.

Action Parameters

campaignId
string
customerId
string
email
string
endDate
string
limit
integer
page
integer
sort
string
startDate
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: RETENTLY_GET_FEEDBACK_BY_ID

Tool to retrieve detailed information about specific feedback by its unique id. use when you need to get the details of a single feedback entry.

Action Parameters

feedback_id
stringRequired

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
successful
booleanRequired

SLUG: RETENTLY_GET_LATEST_SCORE

Tool to retrieve the latest nps score for the account. use when you need to get the most up-to-date nps score.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: RETENTLY_GET_OUTBOX

Retrieve the outbox of surveys that are scheduled to be sent.

Action Parameters

email
string
limit
integerDefaults to 50
page
integerDefaults to 1
sort
stringDefaults to -surveyCreatedDate

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
successful
booleanRequired

SLUG: RETENTLY_GET_REPORTS

Tool to retrieve reports related to nps surveys, including scores and trends. use when you need to get campaign performance data.

Action Parameters

campaign_id
string
end_date
string
start_date
string

Action Response

code
integerRequired
data
arrayRequired
error
string
message
stringRequired
successful
booleanRequired

SLUG: RETENTLY_GET_TEMPLATES

Tool to retrieve a list of survey templates available in the account. use when you need to get the available survey templates.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: RETENTLY_SEND_TRANSACTIONAL_SURVEY

Tool 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.

Action Parameters

campaign_id
stringRequired
delay
integer
subscribers
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: RETENTLY_UNSUBSCRIBE_CUSTOMERS

Unsubscribe customers from receiving surveys by providing their email addresses.

Action Parameters

message
string
subscribers
arrayRequired

Action Response

code
integerRequired
data
arrayRequired
error
string
message
stringRequired
successful
booleanRequired