NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Smtp2go connects to a Nagent workspace with an API key. Once it is connected, agents can call 32 Smtp2go actions, such as "Search Email Activity", "Add Allowed Sender" and "Update Allowed Senders". 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 Smtp2go, with input parameters and output schema.
SMTP2GO_ACTIVITY_SEARCHTool to search activity events like sends, opens, clicks, and bounces. Use when you need to filter account email activity by date, event, recipient, or message ID.
Input parameters
Number of results to return, defaults to 100, maximum 1000
Number of records to skip for pagination
Filter criteria for searching email activity.
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
SMTP2GO_ALLOWED_SENDERS_ADDTool to add a new allowed sender email address. Use when you need to whitelist a sender before sending email. Example: Add "user@example.com" to allowed senders list.
Input parameters
Email address to add as an allowed sender.
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
SMTP2GO_ALLOWED_SENDERS_REMOVETool to remove a sender email address from the allowed senders list. Use when you need to revoke send permissions for a validated address.
Input parameters
The email address to remove from the allowed senders list
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
SMTP2GO_ALLOWED_SENDERS_UPDATETool to update (replace) the entire allowed senders list in your SMTP2GO account. This action overwrites the current list with the provided email addresses and domain names. Use when you need to set or update who can send emails through your account. Example: 'Update allowed senders to include user@example.com and admin@company.com in whitelist mode.'
Input parameters
A string indicating how the list of email addresses and domain names is interpreted. 'whitelist' allows only listed senders, 'blacklist' blocks listed senders, 'disabled' turns off the feature.
If you wish to make this API call on behalf of a subaccount then include its unique ID here.
Array of email addresses and/or domain names that will be allowed to send emails through your account. This replaces the existing list.
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
SMTP2GO_ALLOWED_SENDERS_VIEWTool to view the list of allowed senders configured in your account. Use after setting up SMTP2GO authentication to retrieve your allowed-senders list. Example: 'Show me all verified allowed senders.'
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
SMTP2GO_DOMAIN_ADDTool to add a new sender domain for SPF/DKIM verification. Use when you need to register a domain and optionally set tracking/return-path subdomains.
Input parameters
The domain to add as a sending domain (top-level or subdomain).
If true, SMTP2GO will attempt to verify SPF/DKIM records automatically.
Unique ID of the subaccount (if you manage multiple subaccounts).
Subdomain for click/open tracking and unsubscribe links; defaults to 'link' if omitted.
Subdomain to use as the return-path (bounce) domain.
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
SMTP2GO_EMAIL_SEARCHTool to search sent emails. Use when filtering your SMTP2GO account's email activity by criteria like date, sender, or recipient. Call after authentication.
Input parameters
Filter only events matching this type (e.g., 'bounce', 'spam', etc.).
Number of results to return (default 100, max 500).
Pagination offset (default 0).
Return only results for this specific sender email.
Return only results with this status (e.g., 'sent', 'dropped').
Sort returned items by this field.
Return only results with this exact subject line.
End date (YYYY-MM-DD) for filtering results.
Return only results for this specific email ID.
Return only results for this specific recipient email.
Start date (YYYY-MM-DD) for filtering results.
Order of returned 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
SMTP2GO_IP_ALLOW_LIST_ADDTool to add a public IP address to your account's IP allow list. Use when you need to whitelist specific sending sources by IP after confirming accuracy. Note: Only plain IP addresses are supported (no CIDR notation). Private/reserved IP ranges are rejected.
Input parameters
Public IP address to add to the allow list (e.g., '8.8.8.8'). Note: CIDR notation is NOT supported; use plain IP addresses only. Private/reserved IP ranges are not allowed.
Optional note for your reference (max 255 characters).
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
SMTP2GO_IP_ALLOW_LIST_REMOVETool to remove an IP address from your account's IP allow list. Use after identifying the IP you wish to revoke.
Input parameters
The IPv4 address to remove from the allow list.
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
SMTP2GO_IP_ALLOW_LIST_VIEWTool to view the list of IP addresses in your IP allow list. Use after confirming your SMTP2GO API key is set.
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
SMTP2GO_SMS_VIEW_RECEIVEDTool to retrieve received SMS replies for your SMTP2GO account. Use when you need to fetch incoming SMS messages for analysis or display. Pagination supported via limit and offset.
Input parameters
Number of received SMS messages to return (default 100, max 500)
Number of messages to skip for pagination (default 0)
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
SMTP2GO_STATS_EMAIL_BOUNCESTool to retrieve email bounces statistics. Use after sending emails to analyze bounce metrics over a time period.
Input parameters
Filter results by a specific email address
Number of records to return, defaults to API default
Record offset for pagination, defaults to API default
End date (inclusive) in YYYY-MM-DD format to filter bounces
Start date (inclusive) in YYYY-MM-DD format to filter bounces
Field by which to sort results, e.g., date_bounced
Sort direction for results, either ASC or DESC
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
SMTP2GO_STATS_EMAIL_CYCLETool to retrieve current email cycle/quota statistics. Use when you need to check the account's monthly email allowance, usage, and remaining quota for the current billing cycle.
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
SMTP2GO_STATS_EMAIL_HISTORYTool to retrieve email history statistics. Use when you need detailed delivery metrics within a date range.
Input parameters
Filter results by message tag.
Filter results by recipient email address.
Maximum number of records to return (1–1000).
Number of records to skip for pagination.
Filter results by sender email address.
End date for filtering (YYYY-MM-DD).
Start date for filtering (YYYY-MM-DD).
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
SMTP2GO_STATS_EMAIL_SPAMTool to retrieve email spam report statistics. Use when analyzing spam trends for sent emails.
Input parameters
Number of records to return (default 100, max 1000).
Pagination offset (default 0).
Filter results by sender email address.
End date (YYYY-MM-DD) for filtering spam statistics.
Filter results by recipient email address.
Start date (YYYY-MM-DD) for filtering spam statistics.
Filter results by transaction 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
SMTP2GO_STATS_EMAIL_UNSUBSTool to retrieve email unsubscribe statistics. Use when you need unsubscribe data for your account over a date range.
Input parameters
Ending date (YYYY-MM-DD) for the unsubscribe report.
Starting date (YYYY-MM-DD) for the unsubscribe report.
Maximum number of records to return (1-1000).
Restrict results to this email address.
Number of records to skip 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
SMTP2GO_SUBACCOUNTS_SEARCHTool to search subaccounts. Use after authenticating to filter and paginate your subaccounts by name, email, or status.
Input parameters
Filter results to subaccounts with this name.
Filter results to subaccounts with this email address.
Number of records to return (default 100, max 1000).
Filter results by active status (true or false).
Number of records to skip for pagination (default 0).
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
SMTP2GO_SUBACCOUNTS_USAGETool to retrieve usage statistics for subaccounts. Use when you need to monitor per-subaccount email usage.
Input parameters
ID of the subaccount for which to retrieve usage statistics. If omitted, statistics for all subaccounts are returned.
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
SMTP2GO_SUPPRESSION_ADDTool to add email addresses or domains to the suppression list. Use when you need to block sending emails to specific recipients or entire domains after unsubscribes or bounces.
Input parameters
Type of suppression: EMAIL to suppress addresses, DOMAIN to suppress domains, ALL for both.
Optional note about the suppression reason.
A valid RFC-5322 formatted email address to add to the suppression list. Email addresses added to the suppression list will be blocked from receiving future emails.
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
SMTP2GO_SUPPRESSION_REMOVETool to remove an email address or domain from the suppression list. Use when you want to resume sending to the address or domain.
Input parameters
Email address to remove from suppression list.
Domain to remove from suppression list.
Subaccount ID from which to remove suppression entry.
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
SMTP2GO_SUPPRESSION_VIEWTool to view the suppression list. Use when you need to inspect suppressed email addresses in your account.
Input parameters
Maximum number of results to return (default 100)
Number of results to skip for pagination
Only list suppressions added on or before this date (YYYY-MM-DD)
Only list suppressions added on or after this date (YYYY-MM-DD)
Filter by specific email address
Type of suppression to filter
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
SMTP2GO_TEMPLATE_EDITTool to edit details of an existing email template. Use when you need to update template properties after confirming its ID.
Input parameters
New name for the template
New subject line for the template
New HTML content for the template
New plain text content for the template
New code view content for drag-and-drop editor templates
Whether to archive (true) or unarchive (false) the template
ID of the template to edit
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
SMTP2GO_TEMPLATE_SEARCHTool to search your collection of email templates by ID or name. Use when you need to find templates matching specific criteria after authentication.
Input parameters
Filter by the template name.
Number of results per page (1-1000).
Number of results to skip for pagination.
Filter by the unique template identifier.
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
SMTP2GO_TEMPLATE_VIEWTool to view details of a specific email template. Use after you have the template ID to inspect.
Input parameters
ID of the email template to view
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
SMTP2GO_USERS_SMTP_ADDTool to add a new SMTP user. Use when you need to provision a fresh SMTP credential after collecting username and password.
Input parameters
The SMTP user details to add
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
SMTP2GO_USERS_SMTP_EDITTool to edit details of an existing SMTP user. Use when you need to update username, password, sender restrictions, or enable/disable a user after confirming the target username.
Input parameters
If true, disables this SMTP user entirely.
New password for the SMTP user (minimum 8 characters).
The existing SMTP username to edit.
List of IP addresses permitted for this SMTP user. Omit or pass an empty list to allow any IP.
If true, resets all usage statistics for this SMTP user.
New SMTP username if you wish to change it.
List of specific email addresses this SMTP user is allowed to send from. Omit or pass an empty list to allow any sender.
Restrict sending to this domain only (e.g., 'example.com').
If true, disables all senders for this SMTP 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
SMTP2GO_USERS_SMTP_REMOVETool to remove an SMTP user from your account. Use when you need to revoke SMTP access for a user.
Input parameters
SMTP username to remove, typically an email address or SMTP user 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
SMTP2GO_USERS_SMTP_VIEWTool to list all SMTP users configured on your account. Use when you need to retrieve SMTP user configurations.
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
SMTP2GO_WEBHOOK_ADDTool to create a new webhook. Use when you need real-time notifications of email or SMS events.
Input parameters
Optional human-readable name for the webhook.
List of event types to trigger this webhook.
The destination URL where SMTP2GO will send event notifications.
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
SMTP2GO_WEBHOOK_EDITTool to edit an existing webhook’s settings. Use when you need to update a webhook's configuration after creation.
Input parameters
Destination URL where SMTP2GO will POST webhook events (required for every edit)
List of SMTP2GO user IDs for which this webhook should fire
List of SMS events that will trigger this webhook
Unique identifier of the webhook to be edited (integer ID as string)
Format of the webhook payload
List of email events that will trigger this webhook. Valid events: bounce, unsubscribe, spam, transactional, click, open, delivered. At least one event is required.
Custom email headers to include in the webhook payload
Custom authorization header to include with each webhook request
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
SMTP2GO_WEBHOOK_REMOVETool to remove a webhook. Use when you want to delete a webhook by its ID from your SMTP2GO account.
Input parameters
Unique identifier of the webhook to remove
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
SMTP2GO_WEBHOOK_VIEWTool to view all webhooks configured in your account. Use when you need to inspect existing webhook configurations after setup.
Input parameters
ID of the subaccount to retrieve webhooks for. If omitted, retrieves webhooks for the main account.
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 32 Smtp2go actions on Nagent, including "Search Email Activity", "Add Allowed Sender" and "Update Allowed Senders". Search Email Activity: Search activity events like sends, opens, clicks, and bounces. Each action is listed on this page with its input parameters and its output.
Smtp2go 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.
It also takes 3 optional inputs: limit, offset and search. It returns data, error and successful.