Sendspark

Learn how to use Sendspark with Composio

Overview

SLUG: SENDSPARK

Description

Sendspark is a video messaging platform that empowers businesses to create, send, and track personalized video content, simplifying communication by allowing users to quickly record or upload videos and share them via email, social media, or other digital channels.

Authentication Details

generic_api_key
stringRequired
generic_secret
stringRequired

Connecting to Sendspark

Create an auth config

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

1

Select App

Navigate to Sendspark.

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 Sendspark 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
4sendspark_auth_config_id = "ac_YOUR_SENDSPARK_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 Sendspark 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, sendspark_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 Sendspark 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=["SENDSPARK"])
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: Add Multiple Prospects to Dynamic Campaign

Description

Tool to add multiple prospects to a dynamic campaign in bulk. use when you need to add many prospects to your dynamic video campaign at once after confirming associated charges.

Action Parameters

dynamicsId
stringRequired
processAndAuthorizeCharge
booleanRequired
prospectDepurationConfig
object
prospectList
arrayRequired
workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Prospect to Dynamic Video Campaign

Description

Tool to add a prospect to a dynamic video campaign. use after confirming workspace and campaign ids. example: add new prospect with name/contact details to dynamic "dyn12345" under a known workspace.

Action Parameters

dynamicId
stringRequired
processAndAuthorizeCharge
booleanRequired
prospect
objectRequired
prospectDepurationConfig
object
workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: API Health Status

Description

Tool to check the health status of the sendspark api. use before making other api calls to ensure the service is up.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Dynamic Video Campaign

Description

Tool to create a dynamic video campaign. use when you have a workspace id and want to automate dynamic campaign creation.

Action Parameters

name
stringRequired
workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Webhook

Description

Tool to delete a specific webhook by its id. use when you need to remove an outdated or unnecessary webhook.

Action Parameters

webhook_id
stringRequired
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Prospect Data By Email

Description

Tool to retrieve prospect data by email within a dynamic campaign. use after campaign creation to fetch prospect details.

Action Parameters

dynamic_id
stringRequired
email
stringRequired
workspace_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Dynamic Campaign by ID

Description

Tool to retrieve details of a specific dynamic video campaign. use after confirming workspace and campaign ids.

Action Parameters

dynamic_id
stringRequired
workspace_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Workspace Prospect Data by Email

Description

Tool to retrieve prospect data by email in a dynamic campaign. use after adding a prospect to a campaign to fetch its details.

Action Parameters

dynamic_id
stringRequired
email
Required
workspace_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Dynamic Video Campaigns

Description

Tool to list all dynamic video campaigns in a workspace. use when retrieving campaigns with optional pagination, filtering, or search.

Action Parameters

filters
string
limit
integerDefaults to 10
offset
integerDefaults to 1
search
string
workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Webhooks

Description

Tool to list all configured webhooks. use when you need to audit or verify active webhooks.

Action Parameters

workspaceId
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired