Respond.io
Overview
Section titled “Overview”Respond.io is an AI-powered customer conversation management platform that centralizes messages from multiple channels (WhatsApp, Instagram, email, and more) into a single workspace. With the integration in SquadOS, your agents can create and update contacts, add internal comments to conversations, manage workspace tags, list channels and users, and retrieve specific messages — all in an automated way.
- Official website: https://respond.io/
- Composio documentation: docs.composio.dev/toolkits/respond_io
Authentication
Section titled “Authentication”This tool uses API key (API_KEY) to connect.
You will need the following fields:
| Field | Required | Description |
|---|---|---|
api_key | Yes | Access token generated in the Respond.io dashboard under Settings → Integrations → Developer API. |
How to get credentials
Section titled “How to get credentials”- Go to app.respond.io and log in to your account.
- In the side menu, open the Settings module.
- Go to Integrations and locate Developer API in the integrations list.
- Click Edit next to Developer API.
- Click Add Access Token to generate a new access token.
- Copy the generated token — this is the value to enter in the
api_keyfield when connecting in SquadOS.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Respond.io. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the access token obtained above.
- Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)
Available actions
Section titled “Available actions”Add internal comment to conversation
Section titled “Add internal comment to conversation”RESPOND_IO_CREATE_COMMENT
Tool to add a comment (internal note) to a contact’s conversation. Use after verifying the contact identifier.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
text | string | Yes | Content of the comment (internal note), up to 1000 characters. You can mention other users using {{@user.ID}}. |
identifier | string | Yes | Identifier of the contact; either id:<contact_id>, email:<email> or phone:<E.164_phone>. Example: id:123, email:abdc@gmail.com, phone:+60121233112. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Contact
Section titled “Create Contact”RESPOND_IO_CREATE_CONTACT
Creates a new contact in the respond.io workspace with the specified details. The contact is identified by email, phone number, or contact ID. Supports adding profile information, language preferences, and custom fields that have been pre-configured in the workspace.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
email | string | No | Email address of the contact. |
phone | string | No | Phone number of the contact including country code. |
language | string | No | ISO 639-1 two-letter language code (e.g., en for English, es for Spanish). |
lastName | string | No | Last name of the contact. |
firstName | string | Yes | First name of the contact. |
identifier | string | Yes | Unique identifier for the contact in one of these formats: email:<email_address> (e.g., email:john@example.com), phone:<phone_number> (e.g., phone:+60121233112 with country code), or an existing contact ID. |
profilePic | string | No | URL of the contact’s profile picture. |
countryCode | string | No | ISO 3166-1 alpha-2 two-letter country code (e.g., US for United States, MY for Malaysia). |
custom_fields | array | No | List of custom fields for the contact. Custom fields must already exist in the workspace before they can be assigned to a contact. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Space Tag
Section titled “Create Space Tag”RESPOND_IO_CREATE_SPACE_TAG
Creates a new tag in the Respond.io workspace for organizing and categorizing contacts and conversations. Tags help with segmentation, filtering, and workflow automation. Each tag must have a unique name within the workspace.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the tag. Must be unique within the workspace. Cannot contain emojis or certain invalid characters. Supports spaces, letters, numbers, and common special characters like !@#$%. |
color_code | string | No | Hexadecimal color code for visual identification of the tag in the UI, e.g., #FF5733. Note: Currently the API may reject this parameter with validation errors. |
description | string | No | Brief text describing the tag’s purpose or usage. Helps team members understand when to apply this tag. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Message
Section titled “Get Message”RESPOND_IO_GET_MESSAGE
Tool to retrieve a specific message. Use when you need the details of a message sent to or received from a contact.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
messageId | integer | Yes | Unique ID of the message to retrieve. |
identifier | string | Yes | Identifier of the contact: can be a phone number (+60121233112), email (abdc@gmail.com), or contact ID prefixed by id: (e.g., id:123). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List channels
Section titled “List channels”RESPOND_IO_LIST_CHANNELS
Tool to retrieve a list of channels connected to the workspace. Use when you need to enumerate all messaging channels with pagination support.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of items to return (page size). Default is 10, maximum 100. |
cursorId | integer | No | Pointer to the channel ID from where the next batch of records should start. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List users
Section titled “List users”RESPOND_IO_LIST_USERS
Tool to retrieve a list of users in the workspace. Use when you need to fetch all workspace users for auditing or assignment.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update Space Tag
Section titled “Update Space Tag”RESPOND_IO_UPDATE_SPACE_TAG
Updates an existing workspace tag by its current name. You can modify the tag’s name, description, or emoji. Note: Color codes are not currently supported by the API and will be rejected if provided. At least one field besides currentName must be provided to update.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | New name for the tag (if you want to rename it). |
emoji | string | No | Emoji to associate with the tag (single emoji character). |
colorCode | string | No | Hex color code for the tag. Note: Currently not supported by API and will return error if provided. |
currentName | string | Yes | The current name of the tag you want to update (must match exactly). |
description | string | No | New description for the tag (updates or sets the description). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |