Retently

retently

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

Forms & Surveys Customer Support Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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.

Add Feedback TagsRETENTLY_ADD_FEEDBACK_TAGSAcción

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

Parámetros de entrada

idstringObligatorio
The ID of the feedback response.
opstring
Use the flag “append” in order to append the tags to the response, or leave it empty in order to override existing tags.
tagsstring[]Obligatorio
An array of tags to be added.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Feedback TopicsRETENTLY_ADD_FEEDBACK_TOPICSAcción

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

Parámetros de entrada

topicsobject[]Obligatorio
A list of topics to add to the feedback.
operationstringenum
Use 'append' to add to existing topics, or 'override' to replace them.
appendoverride
feedback_idstringObligatorio
The ID of the feedback to add topics to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create or Update CustomersRETENTLY_CREATE_OR_UPDATE_CUSTOMERSAcción

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.

Parámetros de entrada

subscribersobject[]Obligatorio
A list of customer objects to be created or updated.

Parámetros de salida

codeintegerObligatorio
dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CustomersRETENTLY_DELETE_CUSTOMERSAcción

Delete customers from the workspace by providing their unique ids.

Parámetros de entrada

subscribersobject[]Obligatorio
A list of customer objects to delete.

Parámetros de salida

codeintegerObligatorio
The HTTP status code of the response.
dataobject[]Obligatorio
A list of objects, each representing a deleted customer.
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
A message indicating the result of the delete operation.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CampaignsRETENTLY_GET_CAMPAIGNSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Customer By IDRETENTLY_GET_CUSTOMER_BY_IDAcción

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.

Parámetros de entrada

customer_idstringObligatorio
The ID of the customer to retrieve.

Parámetros de salida

codeintegerObligatorio
dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CustomersRETENTLY_GET_CUSTOMERSAcción

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

Parámetros de entrada

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

Parámetros de salida

codeintegerObligatorio
dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get FeedbackRETENTLY_GET_FEEDBACKAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Feedback by IDRETENTLY_GET_FEEDBACK_BY_IDAcción

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.

Parámetros de entrada

feedback_idstringObligatorio
The unique identifier of the feedback to be retrieved.

Parámetros de salida

codeintegerObligatorio
The HTTP status code of the response.
dataobjectObligatorio
The data returned by the API.
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
A message indicating the result of the request.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest ScoreRETENTLY_GET_LATEST_SCOREAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get OutboxRETENTLY_GET_OUTBOXAcción

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

Parámetros de entrada

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

Parámetros de salida

codeintegerObligatorio
dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ReportsRETENTLY_GET_REPORTSAcción

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

Parámetros de entrada

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

Parámetros de salida

codeintegerObligatorio
dataobject[]Obligatorio
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TemplatesRETENTLY_GET_TEMPLATESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send Transactional SurveyRETENTLY_SEND_TRANSACTIONAL_SURVEYAcción

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.

Parámetros de entrada

delayinteger
The delay in days to send the survey after the triggered event.
campaign_idstringObligatorio
The ID of the campaign where the customers will be surveyed.
subscribersobject[]Obligatorio
A list of customers to send the survey to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unsubscribe CustomersRETENTLY_UNSUBSCRIBE_CUSTOMERSAcción

Unsubscribe customers from receiving surveys by providing their email addresses.

Parámetros de entrada

messagestring
Opt out message.
subscribersobject[]Obligatorio
An array of subscriber emails.

Parámetros de salida

codeintegerObligatorio
The HTTP status code of the response.
dataobject[]Obligatorio
A list of objects containing the email of the unsubscribed customer and a boolean flag indicating the unsubscribed status.
errorstring
Error if any occurred during the execution of the action
messagestringObligatorio
A message indicating the result of the operation.
successfulbooleanObligatorio
Whether or not the action execution was successful or not