Marketing Automation

Customerio

Learn how to use Customerio with Composio

Overview

SLUG: CUSTOMERIO

Description

Customer.io is a customer engagement platform that enables businesses to send targeted messages to their customers through various channels, including email, SMS, and push notifications.

Authentication Details

generic_api_key
stringRequired
region
string

Connecting to Customerio

Create an auth config

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

1

Select App

Navigate to Customerio.

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 Customerio 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
4customerio_auth_config_id = "ac_YOUR_CUSTOMERIO_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 Customerio 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, customerio_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 Customerio 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=["CUSTOMERIO"])
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: Suppress Customer Profile

Description

Tool to suppress a person. use when you need to permanently delete a customer's profile and prevent them from being re-added.

Action Parameters

identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Integrations

Description

Tool to retrieve a list of integrations in your workspace. use when you need to discover configured integrations.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Messages

Description

Tool to retrieve a list of messages sent from your workspace. use when you need paginated delivery metrics for messages, e.g., list email messages delivered between two timestamps.

Action Parameters

action_id
integer
campaign_id
integer
drafts
boolean
end_ts
integer
limit
integerDefaults to 50
metric
string
newsletter_id
integer
start
string
start_ts
integer
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Segment Details

Description

Tool to retrieve details of a specific segment. use after identifying the segment id from list segments.

Action Parameters

segment_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Segment Membership

Description

Tool to retrieve people in a specific segment. use when you need to page through segment membership after identifying segment id.

Action Parameters

limit
integer
segment_id
integerRequired
sort
stringDefaults to asc
start
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Segments

Description

Tool to retrieve a list of segments in your workspace. use when you need to fetch all segments after configuring segment rules.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Trigger

Description

Tool to retrieve details about a specific trigger. use after triggering a broadcast to confirm its status and metadata.

Action Parameters

broadcast_id
integerRequired
trigger_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Triggers

Description

Tool to retrieve a list of triggers for a specific broadcast. use after identifying broadcast id to inspect associated triggers.

Action Parameters

broadcast_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Customer.io Workspace Webhooks

Description

Tool to retrieve a list of webhooks. use after setting up reporting webhooks to fetch current webhook configurations in your workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Collections

Description

Tool to list all collections metadata. use when you need to retrieve current details of each collection in your workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Newsletters

Description

Tool to list all newsletters. use when paginating through newsletter metadata.

Action Parameters

limit
integer
sort
string
start
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Snippets

Description

Tool to list all snippets in your workspace. use when you need to retrieve all reusable content snippets for templating or dynamic content insertion.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Transactional Messages

Description

Tool to list all transactional message templates. use when you need to fetch available transactional messages.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Trigger Broadcast

Description

Tool to manually trigger a broadcast. use when you need to override the default audience and provide personalization data after confirming the broadcast id.

Action Parameters

broadcast_id
integerRequired
data
object
email_add_duplicates
boolean
email_ignore_missing
boolean
id_ignore_missing
boolean
recipients
object

Action Response

data
objectRequired
error
string
successful
booleanRequired