NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Satismeter connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Satismeter actions, such as "Get Unsubscribed Emails", "List Surveys" and "List Users". 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 Satismeter, with input parameters and output schema.
SATISMETER_EMBED_SURVEYTool to generate a JavaScript snippet to embed a SatisMeter survey. Use after configuring your project and obtaining your write key.
Input parameters
Additional user profile information
Unique identifier for the user to target with the survey
Survey display settings including language and custom text
Project Write Key from SatisMeter
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
SATISMETER_GET_UNSUBSCRIBED_EMAILSTool to retrieve list of unsubscribed emails for a project. Use when you need to fetch emails that have opted out of surveys.
Input parameters
Unique ID of the project to retrieve unsubscribed emails for. This is the Project ID found in Settings > Integrations > API in your SatisMeter dashboard (24-character MongoDB ObjectID format, e.g., '68877a5547d1914b110d41bd').
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
SATISMETER_LIST_SURVEYSTool to list surveys (campaigns) in a project. Use when you have a valid project ID and need to retrieve its surveys.
Input parameters
SatisMeter project ID (24-character hex string). Obtain from your connected SatisMeter account or from the SatisMeter dashboard under Project Settings. Do not use project names.
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
SATISMETER_LIST_USERSTool to list users in a project. Use when you have a valid project ID and need to retrieve its users. Optionally filter by a specific user ID.
Input parameters
ID of the project to list users for
Filter by specific user ID (the id passed on the widget) to return only that user
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
SATISMETER_UPDATE_UNSUBSCRIBED_EMAILSTool to update the list of unsubscribed emails for a project. Use when you need to bulk unsubscribe user emails from surveys.
Input parameters
List of email addresses to unsubscribe.
ID of the Satismeter project (24-character MongoDB ObjectId format).
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 5 Satismeter actions on Nagent, including "Get Unsubscribed Emails", "List Surveys" and "List Users". Get Unsubscribed Emails: Retrieve list of unsubscribed emails for a project. Each action is listed on this page with its input parameters and its output.
Satismeter 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.
Get Unsubscribed Emails takes 1 required input: project_id. It returns data, error and successful.