Omnisend

Learn how to use Omnisend with Composio

Overview

SLUG: OMNISEND

Description

Omnisend is a marketing automation platform for ecommerce businesses, focusing on email and SMS marketing.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to Campaigns,Contacts,Orders,Products,Carts,Events,Brands
bearer_token
string
generic_api_key
stringRequired

Connecting to Omnisend

Create an auth config

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

1

Select App

Navigate to Omnisend.

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 Omnisend 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 OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4omnisend_auth_config_id = "ac_YOUR_OMNISEND_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Omnisend: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, omnisend_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4omnisend_auth_config_id = "ac_YOUR_OMNISEND_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": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Omnisend 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, omnisend_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 Omnisend 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=["OMNISEND"])
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: Create Batch

Description

Tool to create a new batch operation for multiple items. use when you need to process many records asynchronously in one call, e.g., bulk contacts, products, orders, or events. use after preparing the items list to avoid rate limits.

Action Parameters

endpoint
stringRequired
eventID
string
items
arrayRequired
method
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create or Update Contact

Description

Tool to create or update a contact in omnisend. use after collecting subscriber details.

Action Parameters

address
string
birthdate
city
string
country
string
countryCode
firstName
string
gender
string
identifiers
arrayRequired
lastName
string
postalCode
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Product

Description

Tool to remove a product from omnisend by its id. use when you need to delete a product and ensure it is no longer available in your catalog.

Action Parameters

product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Batches

Description

Tool to retrieve a list of batch operations. use after initiating a batch job to monitor its progress and results.

Action Parameters

endpoint
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Batch Information

Description

Tool to retrieve information about a specific batch by id. use after submitting a batch when you need a detailed status and counts.

Action Parameters

batchId
stringRequired

Action Response

batchId
stringRequired
batchType
stringRequired
createdAt
stringRequired
data
arrayRequired
error
string
errorCount
integerRequired
processedCount
integerRequired
status
stringRequired
successful
booleanRequired
totalCount
integerRequired
updatedAt
stringRequired

Tool Name: Get Batch Items

Description

Tool to retrieve processed items of a specific batch by id. use when you need to inspect individual results of a batch operation after fetching batch details.

Action Parameters

batchId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact

Description

Tool to retrieve details of a single contact by id. use when you already have a contactid and need the full profile.

Action Parameters

contactId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Contacts

Description

Tool to retrieve a paginated list of contacts with optional filtering. use when you need to fetch contacts in batches and handle cursor pagination.

Action Parameters

after
string
before
string
email
string
limit
integerDefaults to 100
phone
string
segmentID
integer
status
string
tag
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Products

Description

Tool to retrieve a paginated list of products. use when syncing product catalog before campaign creation.

Action Parameters

limit
integerDefaults to 100
offset
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Contact

Description

Tool to update fields of an existing contact by id. use after retrieving contact id. patch https://api.omnisend.com/v3/contacts/{contactid} example: updatecontact(contactid="..., body={firstname: 'john'})

Action Parameters

body
objectRequired
contactId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired