The UniOne connector lets your AI agent act in each user's UniOne account. Each user connects their own UniOne API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 28 tools.
- Tools
- 28
- What they doRead · write · destructive
- 12 · 10 · 612 read10 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the UniOne connection
In AgentKit > Connections, create an UniOne connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'unione'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize UniOne:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'unione_domains_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "unione"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize UniOne:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="unione_domains_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their UniOne credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolunione_domains_listList the account's or project's sending domains with the status of their last verification and DKIM checks.Read-onlyList Domains
List the account's or project's sending domains with the status of their last verification and DKIM checks. Returns each domain with verification and DKIM status. Use unione_domains_list to check whether a domain can send.
Inputs
domainstring- Only this domain. Example: yourdomain.com
limitinteger- Maximum number of domains to return. Defaults to 50. Example: 50
offsetinteger- Index of the first domain to return, starting at 0. Example: 0
unione_event_dump_getGet the status of an event dump and, when ready, its file URLs.Read-onlyGet Event Dump
Get the status of an event dump and, when ready, its file URLs. Returns the dump's status and a list of files to download. Use unione_event_dump_get to poll a dump started with unione_event_dump_create.
Inputs
dump_idstringrequired- Dump ID returned by unione_event_dump_create. Example: fa1f0f13-1d6b-4f8a-8f8b-9f2c5c1d2e3a
unione_event_dumps_listList all existing event dumps.Read-onlyList Event Dumps
List all existing event dumps. Returns each dump's ID, status and files. Use unione_event_dumps_list to see dumps in progress or ready. Use unione_event_dump_get for one.
Inputs
This tool takes no inputs.
unione_suppression_getGet the suppression records for one email address.Read-onlyGet Suppression
Get the suppression records for one email address. Returns each record's cause, source, date and whether it can be deleted. Use unione_suppression_get to find out why an address does not receive email. Use unione_suppressions_list to list many.
Inputs
emailstringrequired- Email address to look up. Example: jane@example.com
all_projectsboolean- For accounts with projects, true searches every project. Example: false
unione_suppressions_listList suppressed addresses since a date, optionally by cause or source, using a cursor for further pages.Read-onlyList Suppressions
List suppressed addresses since a date, optionally by cause or source, using a cursor for further pages. Returns suppression records and a cursor for the next page. Use unione_suppressions_list to export the suppression list. Use unione_suppression_get for one address.
Inputs
causestring- Only this cause: unsubscribed, temporary_unavailable, permanent_unavailable, complained or blocked. One of: unsubscribed, temporary_unavailable, permanent_unavailable, complained, blocked. Example: complainedone of
unsubscribedtemporary_unavailablepermanent_unavailablecomplainedblocked cursorstring- Cursor from the previous response to get the next page; leave empty for the first page. Example: MTI0NTY3
limitinteger- Maximum number of records to return. Defaults to 50. Example: 50
sourcestring- Only this source: user (added with unione_suppression_set), system or subscriber. One of: user, system, subscriber. Example: systemone of
usersystemsubscriber start_timestring- List suppressions from this UTC time (YYYY-MM-DD hh:mm:ss) to now; ignored when cursor is set. Example: 2026-11-01 00:00:00
unione_system_infoGet information about the user or project the API key belongs to.Read-onlyGet Account Info
Get information about the user or project the API key belongs to. Returns the user ID, email, plan, sending limits and, for a project key, the project details. Use unione_system_info to check limits and which account the key belongs to.
Inputs
This tool takes no inputs.
unione_system_pingCheck that the API key is valid.Read-onlyPing
Check that the API key is valid. Returns the user ID the key belongs to. Use unione_system_ping to test the connection. Use unione_system_info for account details.
Inputs
This tool takes no inputs.
unione_template_getGet one email template by ID.Read-onlyGet Template
Get one email template by ID. Returns the template's name, subject, body, sender and settings. Use unione_template_get when you know the ID. Use unione_templates_list to browse.
Inputs
idstringrequired- Template ID from unione_templates_list. Example: a8c3f1e0-6c7b-11ee-9f2d-0242ac120002
unione_templates_listList the account's email templates, paged with limit and offset.Read-onlyList Templates
List the account's email templates, paged with limit and offset. Returns templates with their properties; fewer than limit results means the end of the list. Use unione_templates_list to find a template ID. Use unione_template_get for one template.
Inputs
limitinteger- Maximum number of templates to return. Defaults to 50. Example: 50
offsetinteger- Index of the first template to return, starting at 0. Example: 0
unione_webhook_getGet one webhook by its URL.Read-onlyGet Webhook
Get one webhook by its URL. Returns the webhook's status, format, events and settings. Use unione_webhook_get to check a webhook. Use unione_webhooks_list to list them.
Inputs
urlstringrequired- The webhook's URL. Example: https://yourapp.example/hooks/unione
unione_webhooks_listList the account's or project's webhooks, paged with limit and offset.Read-onlyList Webhooks
List the account's or project's webhooks, paged with limit and offset. Returns each webhook's URL, status and events. Use unione_webhooks_list to see every webhook. Use unione_webhook_get for one.
Inputs
limitinteger- Maximum number of webhooks to return; 50 is recommended. Example: 50
offsetinteger- Index of the first webhook to return, starting at 0. Example: 0
unione_domain_dkim_validateStart checking a domain's DKIM record.WriteValidate Domain DKIM
Start checking a domain's DKIM record. Returns 200 when the check started; read the result later with unione_domains_list (dkim.status). Use unione_domain_dkim_validate after publishing the DKIM record from unione_domain_dns_records_get.
- Idempotent
Inputs
domainstringrequired- Domain to validate the DKIM record for. Example: yourdomain.com
unione_domain_dns_records_getGet the DNS records (verification and DKIM) to publish for a sending domain.WriteGet Domain DNS Records
Get the DNS records (verification and DKIM) to publish for a sending domain. Returns the verification record and DKIM record values. Use unione_domain_dns_records_get first when adding a sending domain, then unione_domain_verification_validate and unione_domain_dkim_validate.
- Idempotent
Inputs
domainstringrequired- Domain to get DNS records for. Example: yourdomain.com
unione_domain_verification_validateStart checking a domain's ownership verification record.WriteValidate Domain Verification
Start checking a domain's ownership verification record. Returns 200 when the check started; read the result later with unione_domains_list (verification_record.status). Use unione_domain_verification_validate after publishing the record from unione_domain_dns_records_get.
- Idempotent
Inputs
domainstringrequired- Domain to validate the verification record for. Example: yourdomain.com
unione_email_sendSend an email to up to 500 recipients, with merge tags, an optional template, tracking, attachments and optional scheduling.WriteSend Email
Send an email to up to 500 recipients, with merge tags, an optional template, tracking, attachments and optional scheduling. Returns the job_id, the emails accepted, and failed_emails with the reason for each invalid, duplicate or unsubscribed address. Use unione_email_send for transactional or bulk email. Use unione_email_subscribe_send to send a resubscribe link. The from_email domain must be verified first (unione_domain_dns_records_get, then the validate tools).
Inputs
recipientsarrayrequired- Recipients (at most 500), each with an email and optional substitutions (per-recipient merge tags) and metadata. Example: [{"email": "jane@example.com", "substitutions": {"to_name": "Jane"}}]
subjectstringrequired- Email subject; may contain merge tags. When template_id is set, the template's subject is used if this is empty. Example: Your November update
ampstring- AMP for Email body; needs an html part too. Example: <!doctype html><html amp4email>...</html>
attachmentsarray- Attachments, each with type (MIME type), name (file name, no slash) and content (base64). Example: [{"type": "text/plain", "name": "readme.txt", "content": "SGVsbG8="}]
from_emailstring- Sender's email address on a domain verified in UniOne. Example: news@yourdomain.com
from_namestring- Sender's display name. Example: Acme Team
global_languagestring- Language of the unsubscribe footer and page: be, de, en, es, fr, it, pl, pt, ru, ua or kz. Example: en
global_metadataobject- Metadata shared by all recipients (at most 10 keys), returned in webhooks; the key campaign_id groups emails into a campaign. Example: {"campaign_id": "nov-newsletter"}
global_substitutionsobject- Merge-tag values shared by all recipients, as name-value pairs; per-recipient substitutions override them. Example: {"company_name": "Acme"}
headersobject- Extra email headers (at most 50); only X- headers are accepted, plus To, CC and BCC. Example: {"X-Campaign": "nov"}
htmlstring- HTML body. Give html or plaintext (or both) unless template_id supplies the body. Example: <p>Hello {{to_name}}, here is your update.</p>
idempotence_keystring- Unique key (up to 64 characters); a repeat send with the same key within a minute is declined. Example: order-12345-confirmation
inline_attachmentsarray- Inline images referenced from the HTML by cid:name, each with type, name and content (base64). Example: [{"type": "image/png", "name": "logo", "content": "iVBORw0KGgo="}]
plaintextstring- Plain-text body. Example: Hello {{to_name}}, here is your update.
reply_tostring- Reply-To email, when different from the sender. Example: support@yourdomain.com
reply_to_namestring- Name shown with the Reply-To address. Example: Acme Support
send_atstring- Schedule the send, in UTC as YYYY-MM-DD hh:mm:ss, at most 24 hours ahead. Example: 2026-11-17 09:00:00
skip_unsubscribeinteger- 1 skips the default unsubscribe footer (needs UniOne support approval), 0 appends it (default). One of: 0, 1. Example: 0one of
01 tagsarray- Up to 4 unique tags (50 characters each) to categorise the email in statistics. Example: ["newsletter"]
template_enginestring- Engine that fills merge tags: simple ({{name}} style), velocity, liquid or none. Defaults to simple. One of: simple, velocity, liquid, none. Example: simpleone of
simplevelocityliquidnone template_idstring- ID of a template from unione_templates_list; its fields fill anything not sent here. Example: a8c3f1e0-6c7b-11ee-9f2d-0242ac120002
track_linksinteger- 1 turns click tracking on (default), 0 off; turning it off needs UniOne support to enable the option. One of: 0, 1. Example: 1one of
01 track_readinteger- 1 turns open tracking on (default), 0 off; turning it off needs UniOne support to enable the option. One of: 0, 1. Example: 1one of
01 unsubscribe_urlstring- Custom unsubscribe URL, used instead of UniOne's own page. Example: https://yourdomain.com/unsubscribe?u={{user_id}}
unione_email_subscribe_sendSend a former subscriber an email with a link to subscribe again, for someone who unsubscribed or was blocked after a complaint.WriteSend Resubscribe Email
Send a former subscriber an email with a link to subscribe again, for someone who unsubscribed or was blocked after a complaint. Returns a status. The address is unblocked only after the recipient clicks the link. Use unione_email_subscribe_send when a user asks to receive emails again. Use unione_suppression_delete for addresses UniOne lets you delete directly.
Inputs
from_emailstringrequired- Sender's email address. Example: news@yourdomain.com
from_namestringrequired- Sender's name. Example: Acme Team
to_emailstringrequired- The former subscriber's email address. Example: jane@example.com
unione_email_validateCheck whether an email address is valid and deliverable.WriteValidate Email Address
Check whether an email address is valid and deliverable. At most two checks may run at once; a slow mail server gives unknown after 5 seconds. Returns the result (valid, invalid, suspicious or unknown) and the reason. Use unione_email_validate before adding an address to a list. Checks may count against your plan's validation quota.
Inputs
emailstringrequired- Email address to check. Example: jane@example.com
unione_event_dump_createStart preparing a CSV export of email events (or aggregated daily statistics) for a time range, optionally filtered.WriteCreate Event Dump
Start preparing a CSV export of email events (or aggregated daily statistics) for a time range, optionally filtered. At most 10 dumps exist at once; each is kept 8 hours. Returns the dump_id; poll unione_event_dump_get until it is ready and returns file URLs. Use unione_event_dump_create for delivery and engagement reports. Use unione_webhook_set for real-time events.
Inputs
start_timestringrequired- Start of the period, UTC YYYY-MM-DD hh:mm:ss; data is kept up to 32 days depending on plan. Example: 2026-11-01 00:00:00
aggregatestring- day_status for counts per day and status, or day_status_domain to also split by recipient domain; leave empty for raw events. Example: day_status
all_projectsboolean- For accounts with projects, true includes every project. Example: false
delimiterstring- Field delimiter: , (default) or ;. Example: ,
dump_fieldsarray- Columns to include, in order, for example event_time, job_id, email, status, delivery_status, subject. Example: ["event_time", "email", "status", "delivery_status"]
end_timestring- End of the period (exclusive), UTC YYYY-MM-DD hh:mm:ss. Example: 2026-11-16 00:00:00
filterobject- Filter with any of job_id, status (sent, delivered, opened, clicked, unsubscribed, subscribed, soft_bounced, hard_bounced, spam), delivery_status (comma-separated), email, email_from, domain and campaign_id. Example: {"status": "hard_bounced", "email_from": "news@yourdomain.com"}
formatstring- csv (default) or csv_gzip. One of: csv, csv_gzip. Example: csvone of
csvcsv_gzip limitinteger- Maximum number of events. Defaults to 50; above 100000 the dump is split into several files. Example: 100000
unione_suppression_setAdd an email address to the suppression list so emails to it are not sent.WriteAdd Suppression
Add an email address to the suppression list so emails to it are not sent. Returns a status. Use unione_suppression_set to block an address. Use unione_suppression_delete to remove it later.
- Idempotent
Inputs
causestringrequired- Why the address is suppressed: unsubscribed, temporary_unavailable, permanent_unavailable or complained. One of: unsubscribed, temporary_unavailable, permanent_unavailable, complained. Example: unsubscribedone of
unsubscribedtemporary_unavailablepermanent_unavailablecomplained emailstringrequired- Email address to suppress. Example: jane@example.com
createdstring- When the suppression started, in UTC as YYYY-MM-DD hh:mm:ss. Defaults to now. Example: 2026-11-16 10:00:00
unione_template_setCreate an email template, or update one when its id is given.WriteCreate or Update Template
Create an email template, or update one when its id is given. Returns the template, including its id. Use unione_template_set to store reusable email content for unione_email_send. Use unione_template_get to read one first.
Inputs
from_emailstringrequired- Default sender email address. Example: news@yourdomain.com
namestringrequired- Template name. Example: Welcome email
attachmentsarray- Attachments, each with type (MIME type), name (file name, no slash) and content (base64). Example: [{"type": "text/plain", "name": "readme.txt", "content": "SGVsbG8="}]
editor_typestring- html (default) or visual; visual templates can only be created in the web app. One of: html, visual. Example: htmlone of
htmlvisual from_namestring- Sender's display name. Example: Acme Team
global_metadataobject- Metadata shared by all recipients (at most 10 keys), returned in webhooks; the key campaign_id groups emails into a campaign. Example: {"campaign_id": "nov-newsletter"}
global_substitutionsobject- Merge-tag values shared by all recipients, as name-value pairs; per-recipient substitutions override them. Example: {"company_name": "Acme"}
headersobject- Extra email headers (at most 50); only X- headers are accepted, plus To, CC and BCC. Example: {"X-Campaign": "nov"}
htmlstring- HTML body. Example: <p>Welcome {{to_name}}!</p>
idstring- ID of the template to edit; leave empty to create a new template. Example: a8c3f1e0-6c7b-11ee-9f2d-0242ac120002
inline_attachmentsarray- Inline images referenced from the HTML by cid:name, each with type, name and content (base64). Example: [{"type": "image/png", "name": "logo", "content": "iVBORw0KGgo="}]
plaintextstring- Plain-text body. Example: Welcome {{to_name}}!
reply_tostring- Reply-To email, when different from the sender. Example: support@yourdomain.com
reply_to_namestring- Name shown with the Reply-To address. Example: Acme Support
subjectstring- Default subject; may contain merge tags. Example: Welcome, {{to_name}}
template_enginestring- Engine that fills merge tags: simple ({{name}} style), velocity, liquid or none. Defaults to simple. One of: simple, velocity, liquid, none. Example: simpleone of
simplevelocityliquidnone track_linksinteger- 1 turns click tracking on (default), 0 off; turning it off needs UniOne support to enable the option. One of: 0, 1. Example: 1one of
01 track_readinteger- 1 turns open tracking on (default), 0 off; turning it off needs UniOne support to enable the option. One of: 0, 1. Example: 1one of
01
unione_webhook_setCreate a webhook (event notification handler), or update the one with the same URL.WriteCreate or Update Webhook
Create a webhook (event notification handler), or update the one with the same URL. Returns the webhook's properties. Use unione_webhook_set to get delivery, open, click, bounce or spam-block events. Set status to disabled to pause a webhook without deleting it.
- Idempotent
Inputs
urlstringrequired- URL that receives the notifications; unique per account or project, ASCII only. Example: https://yourapp.example/hooks/unione
delivery_infointeger- 1 includes detailed delivery info (SMTP response and internal status), 0 does not. One of: 0, 1. Example: 1one of
01 event_formatstring- json_post (default) or json_post_gzip. One of: json_post, json_post_gzip. Example: json_postone of
json_postjson_post_gzip eventsobject- Events to report: email_status lists statuses (sent, delivered, opened, clicked, unsubscribed, subscribed, soft_bounced, hard_bounced, spam), and spam_block ["*"] reports spam blocks. Example: {"email_status": ["delivered", "opened", "hard_bounced"], "spam_block": ["*"]}
max_parallelinteger- Maximum parallel requests UniOne may make to your URL. Example: 10
single_eventinteger- 1 sends one event per call (not recommended), 0 allows several. One of: 0, 1. Example: 0one of
01 statusstring- active (default), disabled (paused by you) or stopped (paused by UniOne after errors). One of: active, disabled, stopped. Example: activeone of
activedisabledstopped
unione_domain_deleteDelete a sending domain.DestructiveDelete Domain
Delete a sending domain. A project's domain can only be deleted with that project's API key. Returns a status. Use unione_domain_delete to stop sending from a domain.
- Idempotent
Inputs
domainstringrequired- Domain to delete. Example: yourdomain.com
unione_event_dump_deleteDelete an event dump from the queue or storage.DestructiveDelete Event Dump
Delete an event dump from the queue or storage. Returns a status. Use unione_event_dump_delete to free one of the 10 dump slots.
- Idempotent
Inputs
dump_idstringrequired- Dump ID from unione_event_dumps_list. Example: fa1f0f13-1d6b-4f8a-8f8b-9f2c5c1d2e3a
unione_suppression_deleteRemove an email address from the suppression list; only records marked is_deletable can be removed.DestructiveDelete Suppression
Remove an email address from the suppression list; only records marked is_deletable can be removed. Returns a status. API error 3003 means no record exists, 3004 means none can be deleted, 906 means the daily delete limit was reached. Use unione_suppression_delete to allow sending to an address again. Use unione_email_subscribe_send for unsubscribed users.
- Idempotent
Inputs
emailstringrequired- Email address to remove from the suppression list. Example: jane@example.com
unione_tag_deleteDelete a user-defined tag.DestructiveDelete Tag
Delete a user-defined tag. Returns a status. Use unione_tag_delete to free space under the 10000-tag limit.
- Idempotent
Inputs
tag_idintegerrequired- Tag ID from unione_tags_list. Example: 123
unione_template_deleteDelete an email template by ID.DestructiveDelete Template
Delete an email template by ID. Returns a status. Use unione_template_delete to remove a template permanently.
- Idempotent
Inputs
idstringrequired- Template ID from unione_templates_list. Example: a8c3f1e0-6c7b-11ee-9f2d-0242ac120002
unione_webhook_deleteDelete a webhook by its URL.DestructiveDelete Webhook
Delete a webhook by its URL. Returns a status. Use unione_webhook_delete to remove a webhook. Use unione_webhook_set with status disabled to pause it instead.
- Idempotent
Inputs
urlstringrequired- The webhook's URL. Example: https://yourapp.example/hooks/unione
No tools match.