Smtp2go
smtp2goSMTP2GO is a reliable email delivery service that ensures your emails reach recipients' inboxes efficiently.
Acciones disponibles (32)
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.
Search Email ActivitySMTP2GO_ACTIVITY_SEARCHAcciónTool 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.
SMTP2GO_ACTIVITY_SEARCHAcciónTool 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.
Parámetros de entrada
limitintegerNumber of results to return, defaults to 100, maximum 1000
offsetintegerNumber of records to skip for pagination
searchobjectFilter criteria for searching email activity.
Parámetros de salida
dataobject[]ObligatorioList of activity records matching search criteria
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of matching records
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Allowed SenderSMTP2GO_ALLOWED_SENDERS_ADDAcciónTool 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.
SMTP2GO_ALLOWED_SENDERS_ADDAcciónTool 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.
Parámetros de entrada
email_addressanyObligatorioemailEmail address to add as an allowed sender.
Parámetros de salida
dataobjectObligatorioData returned for the added allowed sender.
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioError code returned by SMTP2GO API
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message returned by SMTP2GO API
Remove Allowed SenderSMTP2GO_ALLOWED_SENDERS_REMOVEAcciónTool to remove a sender email address from the allowed senders list. use when you need to revoke send permissions for a validated address.
SMTP2GO_ALLOWED_SENDERS_REMOVEAcciónTool to remove a sender email address from the allowed senders list. use when you need to revoke send permissions for a validated address.
Parámetros de entrada
email_addressanyObligatorioemailThe email address to remove from the allowed senders list
Parámetros de salida
dataobjectData section of the response.
errorstringError if any occurred during the execution of the action
error_codeintegerError code if the operation failed
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message if the operation failed or was unsuccessful
Update Allowed SenderSMTP2GO_ALLOWED_SENDERS_UPDATEAcciónTool to update details of an existing allowed sender. use after confirming the allowed sender id.
SMTP2GO_ALLOWED_SENDERS_UPDATEAcciónTool to update details of an existing allowed sender. use after confirming the allowed sender id.
Parámetros de entrada
namestringNew display name for the allowed sender
reply_promptbooleanWhether reply prompt is enabled for this sender
email_addressanyemailNew email address for the allowed sender
allowed_sender_idstringObligatorioThe ID of the allowed sender to update
Parámetros de salida
dataobjectObligatorioUpdated allowed sender details
errorstringError if any occurred during the execution of the action
request_idstringObligatorioUnique ID for this API request
successfulbooleanObligatorioWhether or not the action execution was successful or not
View Allowed SendersSMTP2GO_ALLOWED_SENDERS_VIEWAcciónTool 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.'
SMTP2GO_ALLOWED_SENDERS_VIEWAcciónTool 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.'
Parámetros de entrada
limitintegerMaximum number of results to return (1-1000).
offsetintegerNumber of results to skip for pagination.
verifiedstringenumFilter by verification status ('verified' or 'unverified').
verifiedunverifiedsender_emailstringFilter by exact sender email address.
Parámetros de salida
dataobject[]ObligatorioList of allowed sender records matching the query.
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of matched senders.
error_codeintegerObligatorioZero if successful; otherwise an error code.
request_idstringObligatorioUnique ID for this API request.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Sender DomainSMTP2GO_DOMAIN_ADDAcciónTool 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.
SMTP2GO_DOMAIN_ADDAcciónTool 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.
Parámetros de entrada
domainstringObligatorioThe domain to add as a sending domain (top-level or subdomain).
auto_verifybooleanIf true, SMTP2GO will attempt to verify SPF/DKIM records automatically.
subaccount_idstringUnique ID of the subaccount (if you manage multiple subaccounts).
tracking_subdomainstringSubdomain for click/open tracking and unsubscribe links; defaults to 'link' if omitted.
returnpath_subdomainstringSubdomain to use as the return-path (bounce) domain.
Parámetros de salida
dataobjectObligatorioDetails of the added domain(s).
errorstringError if any occurred during the execution of the action
request_idstringObligatorioUnique ID for this API request.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search SMTP2GO EmailsSMTP2GO_EMAIL_SEARCHAcciónTool to search sent emails. use when filtering your smtp2go account's email activity by criteria like date, sender, or recipient. call after authentication.
SMTP2GO_EMAIL_SEARCHAcciónTool to search sent emails. use when filtering your smtp2go account's email activity by criteria like date, sender, or recipient. call after authentication.
Parámetros de entrada
eventstringFilter only events matching this type (e.g., 'bounce', 'spam', etc.).
limitintegerNumber of results to return (default 100, max 500).
offsetintegerPagination offset (default 0).
senderanyemailReturn only results for this specific sender email.
statusstringReturn only results with this status (e.g., 'sent', 'dropped').
sort_bystringSort returned items by this field.
subjectstringReturn only results with this exact subject line.
date_endanydateEnd date (YYYY-MM-DD) for filtering results.
email_idstringReturn only results for this specific email ID.
recipientanyemailReturn only results for this specific recipient email.
date_startanydateStart date (YYYY-MM-DD) for filtering results.
sort_orderstringenumOrder of returned results.
ascdesc
Parámetros de salida
dataobjectObligatorioContainer for search results; includes 'emails' list.
errorstringError if any occurred during the execution of the action
statusstringObligatorioenumAPI call status.
successerrorsuccessfulbooleanObligatorioWhether or not the action execution was successful or not
Add IP Allow ListSMTP2GO_IP_ALLOW_LIST_ADDAcciónTool to add an ip address or cidr range to your account’s ip allow list. use when you need to whitelist specific sending sources by ip or cidr after confirming accuracy.
SMTP2GO_IP_ALLOW_LIST_ADDAcciónTool to add an ip address or cidr range to your account’s ip allow list. use when you need to whitelist specific sending sources by ip or cidr after confirming accuracy.
Parámetros de entrada
ipstringObligatorioIP address (e.g., '192.168.1.1') or CIDR range (e.g., '192.168.1.0/24') to add to the allow list.
notestringOptional note for your reference (max 255 characters).
Parámetros de salida
dataobjectObligatorioData returned after adding an IP to the allow list.
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioError code returned by SMTP2GO API
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message returned by SMTP2GO API
Remove IP from Allow ListSMTP2GO_IP_ALLOW_LIST_REMOVEAcciónTool to remove an ip address from your account's ip allow list. use after identifying the ip you wish to revoke.
SMTP2GO_IP_ALLOW_LIST_REMOVEAcciónTool to remove an ip address from your account's ip allow list. use after identifying the ip you wish to revoke.
Parámetros de entrada
ip_addressanyObligatorioipv4The IPv4 address to remove from the allow list.
Parámetros de salida
dataobjectObligatorioResult of the removal operation.
errorstringError if any occurred during the execution of the action
statusstringObligatorioenumStatus of the API call.
successerrorsuccessfulbooleanObligatorioWhether or not the action execution was successful or not
View IP Allow ListSMTP2GO_IP_ALLOW_LIST_VIEWAcciónTool to view the list of ip addresses in your ip allow list. use after confirming your smtp2go api key is set.
SMTP2GO_IP_ALLOW_LIST_VIEWAcciónTool to view the list of ip addresses in your ip allow list. use after confirming your smtp2go api key is set.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioList of allowed IP address entries.
errorstringError if any occurred during the execution of the action
error_codeintegerSMTP2GO error code if the request failed.
successfulbooleanObligatorioWhether or not the action execution was successful or not
View Received SMSSMTP2GO_SMS_VIEW_RECEIVEDAcciónTool 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.
SMTP2GO_SMS_VIEW_RECEIVEDAcciónTool 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.
Parámetros de entrada
limitintegerNumber of received SMS messages to return (default 100, max 500)
offsetintegerNumber of messages to skip for pagination (default 0)
Parámetros de salida
dataobject[]ObligatorioList of received SMS messages
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of received SMS messages available
error_codeintegerObligatorioAPI error code (0 if no error)
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Email Bounces StatsSMTP2GO_STATS_EMAIL_BOUNCESAcciónTool to retrieve email bounces statistics. use after sending emails to analyze bounce metrics over a time period.
SMTP2GO_STATS_EMAIL_BOUNCESAcciónTool to retrieve email bounces statistics. use after sending emails to analyze bounce metrics over a time period.
Parámetros de entrada
emailanyemailFilter results by a specific email address
limitintegerNumber of records to return, defaults to API default
offsetintegerRecord offset for pagination, defaults to API default
date_endanydateEnd date (inclusive) in YYYY-MM-DD format to filter bounces
date_startanydateStart date (inclusive) in YYYY-MM-DD format to filter bounces
sort_fieldstringField by which to sort results, e.g., date_bounced
sort_directionstringenumSort direction for results, either ASC or DESC
ASCDESC
Parámetros de salida
dataobject[]ObligatorioArray of bounce record objects
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of bounces matching filters
successbooleanObligatorioIndicates if the request was successful
error_codestringError code if the request failed
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message if the request failed
Email Cycle StatisticsSMTP2GO_STATS_EMAIL_CYCLEAcciónTool to retrieve email cycle statistics. use when you need to analyze email delivery metrics over a specified date range.
SMTP2GO_STATS_EMAIL_CYCLEAcciónTool to retrieve email cycle statistics. use when you need to analyze email delivery metrics over a specified date range.
Parámetros de entrada
limitintegerMaximum number of records to return
offsetintegerNumber of records to skip for pagination
date_toanyObligatoriodateEnd date for the report in YYYY-MM-DD format
group_bystringenumTime granularity to group statistics by
dayweekmonthgroupingstringOptional secondary grouping key, e.g., 'user'
date_fromanyObligatoriodateStart date for the report in YYYY-MM-DD format
Parámetros de salida
dataobject[]ObligatorioList of statistics grouped by cycle
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of records returned
successfulbooleanObligatorioWhether or not the action execution was successful or not
Email History StatisticsSMTP2GO_STATS_EMAIL_HISTORYAcciónTool to retrieve email history statistics. use when you need detailed delivery metrics within a date range.
SMTP2GO_STATS_EMAIL_HISTORYAcciónTool to retrieve email history statistics. use when you need detailed delivery metrics within a date range.
Parámetros de entrada
tagstringFilter results by message tag.
emailanyemailFilter results by recipient email address.
limitintegerMaximum number of records to return (1–1000).
offsetintegerNumber of records to skip for pagination.
senderanyemailFilter results by sender email address.
date_endanydateEnd date for filtering (YYYY-MM-DD).
date_startanydateStart date for filtering (YYYY-MM-DD).
Parámetros de salida
dataobject[]ObligatorioList of email history records returned.
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of emails matching the query.
request_idstringObligatorioUnique ID for this API request.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Email Spam StatisticsSMTP2GO_STATS_EMAIL_SPAMAcciónTool to retrieve email spam report statistics. use when analyzing spam trends for sent emails.
SMTP2GO_STATS_EMAIL_SPAMAcciónTool to retrieve email spam report statistics. use when analyzing spam trends for sent emails.
Parámetros de entrada
limitintegerNumber of records to return (default 100, max 1000).
offsetintegerPagination offset (default 0).
senderanyemailFilter results by sender email address.
date_endanyObligatoriodateEnd date (YYYY-MM-DD) for filtering spam statistics.
recipientanyemailFilter results by recipient email address.
date_startanyObligatoriodateStart date (YYYY-MM-DD) for filtering spam statistics.
transaction_idstringFilter results by transaction ID.
Parámetros de salida
dataobject[]ObligatorioList of spam report statistics.
errorstringError if any occurred during the execution of the action
error_codeintegerError code if the request failed.
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message if the request failed.
Email Unsubscription StatsSMTP2GO_STATS_EMAIL_UNSUBSAcciónTool to retrieve email unsubscribe statistics. use when you need unsubscribe data for your account over a date range.
SMTP2GO_STATS_EMAIL_UNSUBSAcciónTool to retrieve email unsubscribe statistics. use when you need unsubscribe data for your account over a date range.
Parámetros de entrada
date_endanydateEnding date (YYYY-MM-DD) for the unsubscribe report.
date_startanydateStarting date (YYYY-MM-DD) for the unsubscribe report.
result_limitintegerMaximum number of records to return (1-1000).
email_addressanyemailRestrict results to this email address.
result_offsetintegerNumber of records to skip for pagination.
Parámetros de salida
dataobject[]ObligatorioList of unsubscription records.
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioAPI error code (0 indicates success).
request_idstringObligatorioUnique identifier for this API request.
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message if the request failed.
Search SubaccountsSMTP2GO_SUBACCOUNTS_SEARCHAcciónTool to search subaccounts. use after authenticating to filter and paginate your subaccounts by name, email, or status.
SMTP2GO_SUBACCOUNTS_SEARCHAcciónTool to search subaccounts. use after authenticating to filter and paginate your subaccounts by name, email, or status.
Parámetros de entrada
namestringFilter results to subaccounts with this name.
emailstringemailFilter results to subaccounts with this email address.
limitintegerNumber of records to return (default 100, max 1000).
activebooleanFilter results by active status (true or false).
offsetintegerNumber of records to skip for pagination (default 0).
Parámetros de salida
dataobject[]ObligatorioList of subaccount records matching the search criteria.
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of matching subaccounts.
error_codeintegerZero if successful; non-zero if an error occurred.
request_idstringUnique ID for the API request.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Subaccounts UsageSMTP2GO_SUBACCOUNTS_USAGEAcciónTool to retrieve usage statistics for subaccounts. use when you need to monitor per-subaccount email usage.
SMTP2GO_SUBACCOUNTS_USAGEAcciónTool to retrieve usage statistics for subaccounts. use when you need to monitor per-subaccount email usage.
Parámetros de entrada
subaccount_idstringID of the subaccount for which to retrieve usage statistics. If omitted, statistics for all subaccounts are returned.
Parámetros de salida
dataobjectObligatorioUsage statistics data
errorstringError if any occurred during the execution of the action
request_idstringObligatorioUnique ID for this API request
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add to Suppression ListSMTP2GO_SUPPRESSION_ADDAcciónTool 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.
SMTP2GO_SUPPRESSION_ADDAcciónTool 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.
Parámetros de entrada
typestringenumType of suppression: EMAIL to suppress addresses, DOMAIN to suppress domains, ALL for both.
EMAILDOMAINALLdescriptionstringOptional note about the suppression reason.
email_addressstringObligatorioA single email address or list of addresses to add to suppression list. Use domain format (e.g., '@example.com') to suppress entire domain.
Parámetros de salida
dataobjectObligatorioResult data returned by SMTP2GO API.
errorstringError if any occurred during the execution of the action
failedstring[]List of addresses or domains that could not be added
succeededbooleanObligatorioIndicates if the suppression add was successful.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove suppression entrySMTP2GO_SUPPRESSION_REMOVEAcciónTool to remove an email address or domain from the suppression list. use when you want to resume sending to the address or domain.
SMTP2GO_SUPPRESSION_REMOVEAcciónTool to remove an email address or domain from the suppression list. use when you want to resume sending to the address or domain.
Parámetros de entrada
emailanyemailEmail address to remove from suppression list.
domainanyhostnameDomain to remove from suppression list.
subaccount_idstringSubaccount ID from which to remove suppression entry.
Parámetros de salida
dataobjectObligatorioResult details of suppression removal.
errorstringError if any occurred during the execution of the action
request_idstringObligatorioUnique identifier for the removal request.
successfulbooleanObligatorioWhether or not the action execution was successful or not
View Suppression ListSMTP2GO_SUPPRESSION_VIEWAcciónTool to view the suppression list. use when you need to inspect suppressed email addresses in your account.
SMTP2GO_SUPPRESSION_VIEWAcciónTool to view the suppression list. use when you need to inspect suppressed email addresses in your account.
Parámetros de entrada
limitintegerMaximum number of results to return (default 100)
offsetintegerNumber of results to skip for pagination
end_dateanydateOnly list suppressions added on or before this date (YYYY-MM-DD)
start_dateanydateOnly list suppressions added on or after this date (YYYY-MM-DD)
email_addressanyemailFilter by specific email address
suppression_typestringenumType of suppression to filter
bouncesunsubscribesspam complaints
Parámetros de salida
dataobject[]ObligatorioList of suppressed email entries
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal number of matched suppressed addresses
statusstringObligatorioenumAPI response status
successerrorsuccessfulbooleanObligatorioWhether or not the action execution was successful or not
Edit Email TemplateSMTP2GO_TEMPLATE_EDITAcciónTool to edit details of an existing email template. use when you need to update template properties after confirming its id.
SMTP2GO_TEMPLATE_EDITAcciónTool to edit details of an existing email template. use when you need to update template properties after confirming its id.
Parámetros de entrada
namestringNew name for the template
subjectstringNew subject line for the template
html_bodystringNew HTML content for the template
text_bodystringNew plain text content for the template
editor_codestringNew code view content for drag-and-drop editor templates
is_archivedbooleanWhether to archive (true) or unarchive (false) the template
template_idstringObligatorioID of the template to edit
Parámetros de salida
dataobjectObligatorioData object containing edited template ID
errorstringError if any occurred during the execution of the action
error_codestringError code if the request failed
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Email TemplatesSMTP2GO_TEMPLATE_SEARCHAcciónTool to search your collection of email templates by id or name. use when you need to find templates matching specific criteria after authentication.
SMTP2GO_TEMPLATE_SEARCHAcciónTool to search your collection of email templates by id or name. use when you need to find templates matching specific criteria after authentication.
Parámetros de entrada
namestringFilter by the template name.
limitintegerNumber of results per page (1-1000).
offsetintegerNumber of results to skip for pagination.
template_idstringFilter by the unique template identifier.
Parámetros de salida
dataobjectObligatorioSearch results data.
errorstringError if any occurred during the execution of the action
statusstringObligatorioenumAPI call status.
successerrorsuccessfulbooleanObligatorioWhether or not the action execution was successful or not
View Email TemplateSMTP2GO_TEMPLATE_VIEWAcciónTool to view details of a specific email template. use after you have the template id to inspect.
SMTP2GO_TEMPLATE_VIEWAcciónTool to view details of a specific email template. use after you have the template id to inspect.
Parámetros de entrada
template_idstringObligatorioID of the email template to view
Parámetros de salida
dataobjectObligatorioDetails of the email template
errorstringError if any occurred during the execution of the action
error_codestringError code if the request failed
request_idstringObligatorioUnique ID for the request
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add SMTP UserSMTP2GO_USERS_SMTP_ADDAcciónTool to add a new smtp user. use when you need to provision a fresh smtp credential after collecting username and password.
SMTP2GO_USERS_SMTP_ADDAcciónTool to add a new smtp user. use when you need to provision a fresh smtp credential after collecting username and password.
Parámetros de entrada
user_dataobjectObligatorioThe SMTP user details to add
Parámetros de salida
dataobjectObligatorioDetails of the newly added SMTP user(s)
errorstringError if any occurred during the execution of the action
request_idstringObligatorioUnique ID for this API request
successfulbooleanObligatorioWhether or not the action execution was successful or not
Edit SMTP UserSMTP2GO_USERS_SMTP_EDITAcciónTool 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.
SMTP2GO_USERS_SMTP_EDITAcciónTool 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.
Parámetros de entrada
disabledbooleanIf true, disables this SMTP user entirely.
passwordstringNew password for the SMTP user (minimum 8 characters).
usernamestringObligatorioThe existing SMTP username to edit.
allowed_ipsstring[]List of IP addresses permitted for this SMTP user. Omit or pass an empty list to allow any IP.
reset_statsbooleanIf true, resets all usage statistics for this SMTP user.
new_usernamestringNew SMTP username if you wish to change it.
allow_sendersstring[]List of specific email addresses this SMTP user is allowed to send from. Omit or pass an empty list to allow any sender.
sender_domainstringRestrict sending to this domain only (e.g., 'example.com').
disable_sendersbooleanIf true, disables all senders for this SMTP user.
Parámetros de salida
dataobjectObligatorioDetails of the edited SMTP user.
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioError code returned by SMTP2GO API (0 if successful).
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message returned by SMTP2GO API, if any.
Remove SMTP UserSMTP2GO_USERS_SMTP_REMOVEAcciónTool to remove an smtp user from your account. use when you need to revoke smtp access for a user.
SMTP2GO_USERS_SMTP_REMOVEAcciónTool to remove an smtp user from your account. use when you need to revoke smtp access for a user.
Parámetros de entrada
usernamestringObligatorioSMTP username to remove, typically an email address or SMTP user ID.
Parámetros de salida
dataobjectObligatorioDetails of the removed SMTP user(s)
errorstringError if any occurred during the execution of the action
request_idstringObligatorioUnique ID for this API request
successfulbooleanObligatorioWhether or not the action execution was successful or not
View SMTP UsersSMTP2GO_USERS_SMTP_VIEWAcciónTool to list all smtp users configured on your account. use when you need to retrieve smtp user configurations.
SMTP2GO_USERS_SMTP_VIEWAcciónTool to list all smtp users configured on your account. use when you need to retrieve smtp user configurations.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioList of SMTP user configurations
errorstringError if any occurred during the execution of the action
error_codeintegerSMTP2GO error code if the request failed
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add WebhookSMTP2GO_WEBHOOK_ADDAcciónTool to create a new webhook. use when you need real-time notifications of email or sms events.
SMTP2GO_WEBHOOK_ADDAcciónTool to create a new webhook. use when you need real-time notifications of email or sms events.
Parámetros de entrada
namestringOptional human-readable name for the webhook.
eventsstring[]ObligatorioList of event types to trigger this webhook.
webhook_urlanyObligatoriouriThe destination URL where SMTP2GO will send event notifications.
Parámetros de salida
dataobjectObligatorioDetails of the created webhook.
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioError code returned by SMTP2GO API, 0 means success.
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message if API call failed.
Edit WebhookSMTP2GO_WEBHOOK_EDITAcciónTool to edit an existing webhook’s settings. use when you need to update a webhook's configuration after creation.
SMTP2GO_WEBHOOK_EDITAcciónTool to edit an existing webhook’s settings. use when you need to update a webhook's configuration after creation.
Parámetros de entrada
urlanyuriDestination URL where SMTP2GO will POST webhook events
usersstring[]List of SMTP2GO user IDs for which this webhook should fire
sms_eventsstring[]List of SMS events that will trigger this webhook
webhook_idstringObligatorioUnique identifier of the webhook to be edited
output_typestringenumFormat of the webhook payload
jsonformemail_eventsstring[]List of email events that will trigger this webhook
email_headersstring[]Custom email headers to include in the webhook payload
authorization_headerstringCustom authorization header to include with each webhook request
Parámetros de salida
dataobjectObligatorioData returned after editing a webhook.
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioError code returned by SMTP2GO API
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message returned by SMTP2GO API
Remove webhookSMTP2GO_WEBHOOK_REMOVEAcciónTool to remove a webhook. use when you want to delete a webhook by its id from your smtp2go account.
SMTP2GO_WEBHOOK_REMOVEAcciónTool to remove a webhook. use when you want to delete a webhook by its id from your smtp2go account.
Parámetros de entrada
webhook_idstringObligatorioUnique identifier of the webhook to remove
Parámetros de salida
dataobjectObligatorioResult details of the webhook removal operation
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioError code: 0 if successful, non-zero if error
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringObligatorioError message if the request failed
View WebhooksSMTP2GO_WEBHOOK_VIEWAcciónTool to view all webhooks configured in your account. use when you need to inspect existing webhook configurations after setup.
SMTP2GO_WEBHOOK_VIEWAcciónTool to view all webhooks configured in your account. use when you need to inspect existing webhook configurations after setup.
Parámetros de entrada
subaccount_idstringID of the subaccount to retrieve webhooks for. If omitted, retrieves webhooks for the main account.
Parámetros de salida
dataobject[]ObligatorioList of configured webhooks.
errorstringError if any occurred during the execution of the action
error_codeintegerObligatorioError code returned by SMTP2GO API. 0 indicates success.
successfulbooleanObligatorioWhether or not the action execution was successful or not
error_messagestringError message returned by SMTP2GO API if the call failed.