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

Tools

SLUG: SUPERCHAT_CREATE_CONTACT

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

SLUG: SUPERCHAT_CREATE_TEMPLATE_FOLDER

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

SLUG: SUPERCHAT_DELETE_WEBHOOK

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

SLUG: SUPERCHAT_GET_CONTACT

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

SLUG: SUPERCHAT_GET_FILE

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

SLUG: SUPERCHAT_GET_USER

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

SLUG: SUPERCHAT_LIST_CHANNELS

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

SLUG: SUPERCHAT_LIST_CONTACTS

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

SLUG: SUPERCHAT_LIST_CONVERSATIONS

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

SLUG: SUPERCHAT_LIST_CUSTOM_ATTRIBUTES

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

SLUG: SUPERCHAT_LIST_INBOXES

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

SLUG: SUPERCHAT_LIST_LABELS

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

SLUG: SUPERCHAT_LIST_TEMPLATES

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

SLUG: SUPERCHAT_LIST_USERS

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

SLUG: SUPERCHAT_LIST_WEBHOOKS

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

SLUG: SUPERCHAT_UPDATE_CONTACT

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

SLUG: SUPERCHAT_UPDATE_WEBHOOK

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