Respond to Interactive Tool
Submit a user response to an interactive tool (e.g. connecting an app).
Authorizations
Bearer token authentication using your API key
Path Parameters
Chat ID
Message ID
The ID of the tool call being responded to.
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
A user response to an interactive tool, discriminated by response type.
connection The connected connection id (con_...). Omit when declining an app.
The app the person will not connect; its request resolves without a connection.
SCHEDULER, WORKFLOWS, TOOLS, FILES, EMAILS, HTTP_CREDENTIALS, TABLES, PAGES, KNOWLEDGE, SKILLS, CONTACTS, SEGMENTS, ASSISTANTS, AGENTS, CHATS, INBOX, MEMBERS, BROADCASTS, ANALYTICS, AUDIT, PHONE, GMAIL, GOOGLE_SHEETS, GOOGLE_CALENDAR, GOOGLE_DRIVE, GOOGLE_MEET, ONEDRIVE, SHAREPOINT, OUTLOOK_CALENDAR, OUTLOOK, AIRTABLE, NOTION, LINEAR, HUBSPOT, GOHIGHLEVEL, CAL, CALENDLY, RESEND, OAUTH, SLACK, TEAMS, TELEGRAM, TRELLO, FACEBOOK, WHATSAPP, INSTAGRAM, MESSENGER, TIKTOK, JAPIFON, SMPP, TWILIO, TELNYX, ZOHO, ZOHO_BOOKINGS, ZOHO_INVENTORY, ZOHO_CALENDAR, SALESFORCE, STRIPE, SHOPIFY, ZENDESK, MCP, OPENAPI, ODOO, WOOCOMMERCE "SLACK"
Response
The chat message schema
The role of the message
user, assistant, system, tool, event, note The model used for the message
The chat status
RUNNING, COMPLETED, FAILED, CANCELED The message content
System message
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
The member of the chat
Error message if the message failed
ID of the broadcast this message originates from
Whether this message was sent via a broadcast template
The channel the message arrived through, if any
internal, org, agent, custom, whatsapp_bot, messenger_bot, instagram_dm, tiktok_dm, telegram_bot, gmail, outlook, slack_bot, teams_bot, twilio, telnyx, email, smpp The usage information for the message
When the message was delivered to the recipient
Emoji reactions on the message