Marketing Automation

Cardly

Learn how to use Cardly with Composio

Overview

SLUG: CARDLY

Description

Cardly helps businesses create great engagement with customers by getting out of inboxes and into mailboxes.

Authentication Details

generic_api_key
stringRequired

Connecting to Cardly

Create an auth config

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

1

Select App

Navigate to the Cardly toolkit page and click “Setup Integration”.

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

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Cardly 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=["CARDLY"])
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 Contact List

Description

Tool to add a new contact list. use after defining name and optional custom fields, before populating the list with contacts.

Action Parameters

description
string
fields
array
name
stringRequired

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired

Tool Name: Create Webhook

Description

Tool to create a new webhook subscription. use when you need cardly to notify your application via http post for specific events.

Action Parameters

description
string
events
arrayRequired
metadata
object
targetUrl
stringRequired

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired

Tool Name: Delete Invitation by Email

Description

Tool to delete an invitation by email address. use when you need to invalidate an outstanding invitation immediately.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired

Tool Name: Delete Webhook

Description

Tool to delete a webhook. use after confirming the webhook id to immediately cease all activity and event subscriptions for that webhook.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired

Tool Name: Generate Preview

Description

Tool to generate a low-quality, watermarked preview document for a card. use after confirming artwork and template details to estimate costs and delivery.

Action Parameters

artwork
stringRequired
messages
object
purchaseOrderNumber
string
recipient
objectRequired
requestedArrival
string
sender
object
shipToMe
boolean
shippingMethod
string
style
object
template
string
variables
object

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired

Tool Name: List Artwork

Description

Tool to retrieve the currently available artwork for your organisation. use when you need to list and paginate artwork items, optionally filtering to only your own artwork.

Action Parameters

limit
integer
offset
integer
ownOnly
boolean

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Credit History

Description

Tool to list credit history records. use after checking account balance to review recent credits/debits.

Action Parameters

effectiveTime.gt
string
effectiveTime.gte
string
effectiveTime.lt
string
effectiveTime.lte
string
limit
integerDefaults to 25
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired

Tool Name: List Fonts

Description

Tool to list your currently available fonts. use after confirming authentication to explore font options in cardly.

Action Parameters

limit
integerDefaults to 25
offset
integer
organisationOnly
boolean

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Gift Credit History

Description

Tool to list gift credit history records for your organization. use when you need paginated gift credit entries with optional time-based filters.

Action Parameters

effectiveTime.gt
string
effectiveTime.gte
string
effectiveTime.lt
string
effectiveTime.lte
string
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired

Tool Name: List Invitations

Description

Tool to retrieve active invitations for your organisation with optional filters. use when you need to audit invited users and their statuses before sending new invitations or revoking access.

Action Parameters

acceptedOnly
boolean
expiredOnly
boolean
includeAccepted
boolean
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Media

Description

Tool to retrieve the currently available media sizes for product artwork. use when you need to explore or validate media options before creating artwork.

Action Parameters

limit
integer
offset
integer
organisationOnly
boolean

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Orders

Description

Tool to retrieve orders placed by your organisation. use when you need to fetch paginated order history after confirming the endpoint.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Templates

Description

Tool to retrieve your currently available templates from cardly. use to list and paginate templates for selection in card sends.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Users

Description

Tool to retrieve all users associated with your account. use when you need to list and paginate user accounts.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Webhooks

Description

Tool to retrieve any active or disabled webhooks set up for your organisation. use when you need to audit configured webhook endpoints before modifying subscriptions.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: List Writing Styles

Description

Tool to list available writing styles. use when you need to retrieve writing styles available for handwriting personalization.

Action Parameters

limit
integer
offset
integer

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: Retrieve Account Balance

Description

Tool to retrieve the current account and gift credit balances for your organisation. use after authenticating to verify available credit before placing orders.

Action Parameters

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: Retrieve Order

Description

Tool to retrieve information on a specific order. use after obtaining an order id to fetch its details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: Retrieve User

Description

Tool to retrieve detailed information about a specific user. use after obtaining the user id to fetch its details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean

Tool Name: Update Webhook

Description

Tool to update a webhook’s settings, including target url and events. use after retrieving existing webhook to apply configuration changes.

Action Parameters

description
string
disabled
boolean
events
arrayRequired
id
stringRequired
metadata
object
targetUrl
stringRequired

Action Response

data
objectRequired
error
string
state
objectRequired
successful
booleanRequired
testMode
boolean