Unione

Learn how to use Unione with Composio

Overview

SLUG: UNIONE

Description

UniOne is an email delivery service offering a versatile Web API and SMTP API for sending transactional and marketing emails.

Authentication Details

region
stringRequired
generic_api_key
stringRequired

Connecting to Unione

Create an auth config

Use the dashboard to create an auth config for the Unione toolkit. This allows you to connect multiple Unione accounts to Composio for agents to use.

1

Select App

Navigate to Unione.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Unione Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4unione_auth_config_id = "ac_YOUR_UNIONE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Unione for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, unione_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Unione toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["UNIONE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: UniOne Email Balance

Description

Tool to retrieve current account balance. use when you need to check your email usage and limits before sending large campaigns.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel Scheduled Email

Description

Tool to cancel a scheduled transactional email by its job id. use when you need to stop a pending email send before it's dispatched.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Domain Management

Description

Tool to manage sender domains in unione. use when you need dns records for verification, trigger verification or dkim checks, list domains, or delete a domain.

Action Parameters

domain
string
limit
integer
offset
integer
operation
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Email Event

Description

Tool to retrieve details of a specific email event by its id. use when you need event information for auditing or diagnostics.

Action Parameters

event_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Event Types

Description

Tool to retrieve supported email event types. use when you need a list of possible event codes for filtering or analytics.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Email Send Job

Description

Tool to retrieve detailed information about a specific email send job. use when you need its delivery metrics and history.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email List (Export)

Description

Tool to export email events within a specified time frame. it creates an asynchronous event dump which can later be downloaded and parsed using unione event dump get.

Action Parameters

aggregate
string
campaign_id
string
date_from
stringRequired
date_to
string
delimiter
string
delivery_status
string
domain
string
dump_fields
array
email
string
format
string
from_email
string
limit
integerDefaults to 50
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Event Log

Description

Tool to initiate an asynchronous export of email events (event dump). use when you need to export transactional email events for a specified time window.

Action Parameters

aggregate
string
all_projects
boolean
delimiter
string
dump_fields
array
end_time
string
filter
object
format
string
limit
integer
start_time
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Plan

Description

Tool to retrieve current subscription plan details. use when you need to check your project and account plan limits before sending bulk emails.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Pricing

Description

Tool to retrieve current email pricing. use when you need to check per-email cost rates before sending emails.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Quota

Description

Tool to retrieve current email sending quota. use when you need to check your remaining quota before sending emails.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Resend Sent Email

Description

Tool to resend a previously sent email by its job id. use when you need to trigger a resend of an email that has already been sent and you have the original job id.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Resubscribe

Description

Tool to resubscribe a recipient who previously unsubscribed. use when you need to restore a user's subscription status after they opt in again.

Action Parameters

from_email
Required
from_name
stringRequired
to_email
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Resume Paused Email

Description

Tool to resume a paused transactional email by its job id. use when you need to restart a paused pending email send.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Schedule

Description

Tool to schedule a transactional email up to 24 hours ahead. use when you need to send an email at a specific future time.

Action Parameters

message
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email SMTP Configuration

Description

Tool to retrieve smtp server details and credentials. use when you need to configure your mail client or library for smtp sending.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Statistics

Description

Tool to retrieve email sending statistics over a specified time range. this action uses unione's event-dump aggregate api under the hood to compute daily statistics.

Action Parameters

date_from
stringRequired
date_to
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Unsubscribe

Description

Tool to unsubscribe an email from future emails. use when you need to stop all further transactional emails.

Action Parameters

cause
stringRequired
created
string
email
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Validate Email Address

Description

Tool to validate an email address. use when you need deliverability diagnostics after compiling your recipient list.

Action Parameters

email
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Batch Email Validation

Description

Tool to validate multiple email addresses in a batch. use when you need to verify deliverability for a list of emails at once.

Action Parameters

emails
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Resend Email Validation Results

Description

Tool to resend results of an email validation request. use when you need to retrieve validation results again by request id.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Validate Result

Description

Tool to retrieve the detailed result of an email validation request. updated behavior: uses the official single email validation endpoint to synchronously obtain full diagnostics for the provided email address.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retry Email Validation

Description

Tool to retry an email validation request. updated to re-run validation via the official single validation endpoint using the provided email address.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Validate Status

Description

Tool to retrieve the current status of an email validation request. use when you need to poll for completion status.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Email Webhook Types

Description

Tool to retrieve supported email webhook event types. use when configuring your webhook callbacks.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Event Dump

Description

Tool to create an asynchronous csv event dump. use when you need to export transactional email events for a specified time window.

Action Parameters

aggregate
string
all_projects
boolean
delimiter
string
dump_fields
array
end_time
string
filter
object
format
string
limit
integer
start_time
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Event Dump List

Description

Tool to retrieve the full list of event dumps. use when you need to view all existing event-dump tasks.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Schedule Email

Description

Tool to schedule a transactional email up to 24 hours ahead. use when you need to send an email at a specific future time.

Action Parameters

message
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Suppression List

Description

Tool to return the suppression list since a given date. use when auditing bounced, unsubscribed, or blocked recipients.

Action Parameters

cause
string
cursor
string
limit
integerDefaults to 50
source
string
start_time
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Tag

Description

Tool to delete a specific tag. use when you have confirmed the tag id you wish to remove.

Action Parameters

tag_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Tag List

Description

Tool to retrieve all user-defined tags. use when you need to fetch the full list of tags after authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: UniOne Template List

Description

Tool to list email templates. use when you need to retrieve available templates for transactional emails.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set Template

Description

Tool to set or update an email template. use when you need to create or modify transactional email templates before sending messages.

Action Parameters

template
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Email Validation Request

Description

Tool to delete an email validation request. use when a validation job should be canceled by its id.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Event Dump

Description

Tool to retrieve the contents of a specific event dump. use when you have the dump identifier (from event-dump/create) and need its status and download urls.

Action Parameters

dump_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set Webhook

Description

Tool to set or edit a webhook event notification handler. use when you need to configure your webhook for event callbacks.

Action Parameters

delivery_info
integer
event_format
string
events
object
max_parallel
integer
single_event
integer
status
string
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired