Sendfox | Composio Docs

Overview

SLUG: SENDFOX

Description

Template description for sendfox

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Sendfox

Create an auth config

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

Select App

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

Configure Auth Config Settings

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

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

1 from composio import Composio
2 from composio.types import auth_scheme
3 
4 # Replace these with your actual values
5 sendfox_auth_config_id = "ac_YOUR_SENDFOX_CONFIG_ID" # Auth config ID created above
6 user_id = "0000-0000-0000"  # UUID from database/app
7 
8 composio = Composio()
9 
10 def 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 Sendfox for user {user_id}")
23     print(f"Connection status: {connection_request.status}")
24     
25     return connection_request.id
26 
27 
28 connection_id = authenticate_toolkit(user_id, sendfox_auth_config_id)
29 
30 # You can verify the connection using:
31 connected_account = composio.connected_accounts.get(connection_id)
32 print(f"Connected account: {connected_account}")

Tools

Executing tools

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

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["SENDFOX"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def 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 
33 invoke_llm()

Tool List

SENDFOX_DELETE_CONTACT_FROM_LIST

Tool Name: Delete Contact from List

Description

Tool to remove a contact from a specific list in sendfox. use when you need to disassociate a contact by its id from a sendfox list.

Action Parameters

contact_id

integerRequired

list_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_GET_AUTOMATIONS

Tool Name: Get Automations

Description

Tool to retrieve a list of automations. use when you need to list all automations for your sendfox account.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_GET_CAMPAIGNS

Tool Name: Get Campaigns

Description

Tool to retrieve a paginated list of campaigns. use when you need to fetch campaigns in batches or implement pagination. example: "fetch campaigns page 2 with 50 per page.".

Action Parameters

limit

integer

page

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_GET_CONTACTS

Tool Name: Get Contacts

Description

Tool to retrieve a paginated list of contacts. use when you need to fetch contacts in pages, optionally filtering by email.

Action Parameters

string

limit

integer

offset

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_GET_CONTACT_BY_EMAIL

Tool Name: Retrieve Contact by Email

Description

Tool to retrieve a contact by their email address. use when you need to fetch an existing contact’s details by providing their email.

Action Parameters

Required

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_GET_CONTACT_BY_ID

Tool Name: Get Contact by ID

Description

Tool to retrieve a contact's details by id. use after obtaining the contact id to get full contact information.

Action Parameters

contact_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_GET_CONTACT_FIELDS

Tool Name: Get Contact Fields

Description

Tool to retrieve a list of user contact fields. use when you need to discover all contact field metadata before creating or updating contacts. use after authentication is complete.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_GET_LISTS

Tool Name: Get Lists

Description

Tool to retrieve paginated contact lists. use when you need to fetch all your sendfox lists.

Action Parameters

Action Response

data

arrayRequired

error

string

successful

booleanRequired

SENDFOX_GET_LIST_BY_ID

Tool Name: Get List by ID

Description

Tool to retrieve a specific contact list by its id. use when you have a list id and need its details before performing list operations.

Action Parameters

list_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_PATCH_UNSUBSCRIBE_CONTACT

Tool Name: Unsubscribe Contact

Description

Tool to unsubscribe a contact. use when you need to globally mark a contact as unsubscribed.

Action Parameters

Required

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_POST_CREATE_CONTACT

Tool Name: Create Contact

Description

Tool to create a new contact. use when you need to add a new subscriber to sendfox.

Action Parameters

stringRequired

first_name

string

last_name

string

lists

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

SENDFOX_POST_CREATE_LIST

Tool Name: Create List

Description

Tool to create a new contact list. use when you need to add a new list to your sendfox account. example: create a list named 'newsletter subscribers'.

Action Parameters

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired