Superchat

Learn how to use Superchat with Composio

Overview

SLUG: SUPERCHAT

Description

Superchat is a unified messaging platform that enables businesses to communicate with customers across multiple channels, including WhatsApp, Instagram Direct, Facebook Messenger, Email, and more.

Authentication Details

generic_api_key
stringRequired

Connecting to Superchat

Create an auth config

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

1

Select App

Navigate to Superchat.

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 Superchat 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
4superchat_auth_config_id = "ac_YOUR_SUPERCHAT_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 Superchat 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, superchat_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 Superchat 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=["SUPERCHAT"])
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

Description

Tool to create a new contact. use when you need to register contact details before sending messages.

Action Parameters

custom_attributes
array
first_name
string
gender
string
handles
arrayRequired
last_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Template Folder

Description

Tool to create a new template folder in superchat. use when you need to organize message templates into folders before populating them.

Action Parameters

name
stringRequired
parent_folder_id
string

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 obsolete or compromised webhook after confirming its id. example: delete webhook wh 12345.

Action Parameters

webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact

Description

Tool to retrieve details of a specific contact by its id. use when you need to view a contact's information after verifying its existence. example: "fetch contact info for id abc123".

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get File

Description

Tool to retrieve metadata of a specific file. use when you have the file id and need file information before downloading.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User

Description

Tool to retrieve details of a specific user by their id. use when you need to view or manage a user's profile. example: "fetch user info for id '123e4567-e89b-12d3-a456-426614174000'".

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Channels

Description

Tool to list all channels. use when you need to fetch available channels, optionally paginated by `limit`, `after`, or `before`.

Action Parameters

after
string
before
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Contacts

Description

Tool to list all contacts. use when you need to fetch the full list of contacts for selection or reporting.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Conversations

Description

Tool to list all conversations. use when you need to retrieve all conversation ids and metadata, optionally paginated.

Action Parameters

after
string
before
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Custom Attributes

Description

Tool to list all custom contact attributes. use when you need to retrieve definitions of custom contact fields in your account.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Inboxes

Description

Tool to list all inboxes. use when you need to retrieve inbox ids and metadata before sending or organizing messages.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Labels

Description

Tool to list all labels. use when you need to fetch available labels, optionally paginated.

Action Parameters

limit
integer
next
string
previous
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Templates

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Users

Description

Tool to list all users. use when you need to retrieve a directory of all workspace users.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Webhooks

Description

Tool to list all webhooks. use when you need to retrieve all webhooks configured in the workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Contact

Description

Tool to update information for a specific contact in superchat. use after retrieving a contact to modify its name or attributes. example: "update contact co 12345 to change first name to jane."

Action Parameters

contact_id
Required
custom_attributes
array
first_name
string
last_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Webhook

Description

Tool to update the details of a specific webhook. use when you need to modify an existing webhook's url, events, or status.

Action Parameters

events
array
status
string
url
webhook_id
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired