NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Supersaas connects to a Nagent workspace with an API key. Once it is connected, agents can call 10 Supersaas actions, such as "Create User", "Get User" and "List Field List". 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 Supersaas, with input parameters and output schema.
SUPERSAAS_CREATE_USERTool to create a new user in SuperSaaS. Use when you need to add a user to the account. The username is required; all other fields are optional. If a foreign_key is provided, SuperSaaS will use it instead of generating its own ID. Set duplicate='raise' to prevent creating duplicate users with the same foreign key.
Input parameters
Username (max 50 chars). If account is configured for email-only login, this should be the email address.
Role levels for users in SuperSaaS
Email address for the user
Group ID to assign the user to
Phone number
Credit level for the user (default: 0)
Mobile phone number
Physical address of the user
Two character ISO 3166-1 country code (e.g., US, GB, CA)
Set to true to trigger webhooks connected to the account
Password for the user account
IANA timezone identifier (e.g., America/New_York, Europe/London)
Set to 'raise' to return 422 error if a user with the same foreign key already exists. Only applicable when foreign_key is provided.
Full name of the user
Your own foreign key in format '9999fk' (e.g., '12345fk'). If provided, SuperSaaS will use this instead of generating its own 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
SUPERSAAS_DELETE_USERTool to delete a SuperSaaS user by their ID. Use when you need to permanently remove a user from the system.
Input parameters
The unique identifier of the user 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
SUPERSAAS_GET_USERTool to read a single user by ID from SuperSaaS. Use when you need to retrieve detailed information about a specific user.
Input parameters
User ID. Numeric IDs are SuperSaaS keys, alphanumeric are your foreign keys.
Include attached form data in the response.
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
SUPERSAAS_LIST_FIELD_LISTTool to retrieve available fields on Schedule or User objects. Use when you need to discover what custom fields are configured for a schedule or user profile.
Input parameters
The ID of the schedule. Omit this parameter to retrieve User object fields instead of Schedule fields.
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
SUPERSAAS_LIST_GROUPSTool to retrieve all user groups defined in a SuperSaaS account. Use when you need to list groups for managing user access or organizing users.
Input parameters
Account name for authentication
Administrator API key for authentication
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
SUPERSAAS_LIST_PROMOTIONSTool to list all promotional coupon codes in the account or retrieve a single promotion by code. Use when you need to view available promotions or check details of a specific promotion code.
Input parameters
Promotion code to retrieve a single promotion. If provided, returns only the specified promotion.
Maximum number of promotions to return. Use for pagination.
Number of promotions to skip before returning results. Use for pagination.
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
SUPERSAAS_LIST_SCHEDULESTool to retrieve all schedules in a SuperSaaS account with their IDs and names. Use when you need to list available schedules or get schedule IDs for other operations.
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
SUPERSAAS_LIST_SUPER_FORMSTool to retrieve all form definitions in a SuperSaaS account with their IDs and names. Use when you need to list available forms or get form IDs for other operations.
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
SUPERSAAS_LIST_USERSTool to list all users in the SuperSaaS account. Use when you need to retrieve users with optional pagination using limit and offset parameters.
Input parameters
Include attached form data with each user. Set to true to retrieve additional form information.
Maximum number of users to return. Default is 100, maximum is 1000.
Offset for pagination. Use to skip a specified number of users before starting to return results.
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
SUPERSAAS_UPDATE_USERTool to update an existing SuperSaaS user by ID. Use when you need to modify user details like name, email, phone, or role.
Input parameters
User ID to update
Username (max 50 characters)
Role levels for users in SuperSaaS
Email address
Phone number
Credit level balance
Mobile phone number
Mailing address
Full name
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 10 Supersaas actions on Nagent, including "Create User", "Get User" and "List Field List". Create User: Create a new user in SuperSaaS. Each action is listed on this page with its input parameters and its output.
Supersaas 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.
Create User takes 1 required input: name. It also takes 14 optional inputs: role, email, group, phone, credit, mobile, address, country, webhook, password, timezone, duplicate, full_name and foreign_key. It returns data, error and successful.