Respond to interactive tool

POST

chats

{chat_id}

messages

{message_id}

tools

{tool_call_id}

respond

Respond to interactive tool

curl --request POST \
  --url https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "connection",
  "connection_id": "<string>",
  "declined_type": "SLACK"
}
'

import requests

url = "https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond"

payload = {
    "type": "connection",
    "connection_id": "<string>",
    "declined_type": "SLACK"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'connection', connection_id: '<string>', declined_type: 'SLACK'})
};

fetch('https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'connection',
    'connection_id' => '<string>',
    'declined_type' => 'SLACK'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond"

	payload := strings.NewReader("{\n  \"type\": \"connection\",\n  \"connection_id\": \"<string>\",\n  \"declined_type\": \"SLACK\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"connection\",\n  \"connection_id\": \"<string>\",\n  \"declined_type\": \"SLACK\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"connection\",\n  \"connection_id\": \"<string>\",\n  \"declined_type\": \"SLACK\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "role": "user",
  "model": "<string>",
  "status": "RUNNING",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "messages": [
    {
      "role": "system",
      "parts": [
        {
          "type": "text",
          "text": "<string>",
          "audio": {
            "id": "<string>",
            "file_path": "<string>",
            "file_filename": "document.pdf",
            "file_size": 1024,
            "file_mimetype": "application/pdf",
            "file_url": "<string>",
            "created_at": "2023-11-07T05:31:56Z"
          },
          "start_ms": 1,
          "end_ms": 1,
          "html": true,
          "json": true,
          "start_timestamp": 123,
          "end_timestamp": 123
        }
      ]
    }
  ],
  "member": {
    "id": "<string>",
    "role": "ADMIN",
    "user": {
      "id": "<string>",
      "name": "<string>",
      "avatar": "<string>"
    },
    "session": {
      "id": "<string>"
    },
    "contact_channel": {
      "id": "<string>",
      "type": "internal",
      "user_id": "<string>",
      "avatar": "<string>",
      "name": "<string>",
      "username": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "country": "<string>",
      "agent": "<string>",
      "ip": "<string>",
      "language": "<string>",
      "contact": {
        "id": "<string>",
        "name": "<string>",
        "blocked": true,
        "unsubscribed": true,
        "ai_replies": true,
        "is_admin": true,
        "segments": [
          {
            "id": "<string>",
            "name": "<string>",
            "color": "red",
            "contacts_count": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "link": "<string>"
    },
    "agent": {
      "id": "<string>",
      "name": "<string>",
      "icon": "<string>",
      "color": "red",
      "shape": "square",
      "avatar_url": "<string>"
    },
    "seen_at": "2023-11-07T05:31:56Z"
  },
  "error": "<string>",
  "broadcast_id": "<string>",
  "is_broadcast_message": true,
  "channel_type": "internal",
  "usage": {
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123,
    "reasoning_tokens": 123,
    "input_tokens_cache_read": 123,
    "input_tokens_cache_write": 123,
    "turns": [
      {
        "input_tokens": 123,
        "output_tokens": 123,
        "total_tokens": 123,
        "reasoning_tokens": 123,
        "input_tokens_cache_read": 123,
        "input_tokens_cache_write": 123
      }
    ]
  },
  "cost": {
    "total": 123,
    "base": 123,
    "lines": {
      "input": 123,
      "output": 123,
      "reasoning": 123,
      "cache_read": 123,
      "cache_write": 123
    }
  },
  "delivered_at": "2023-11-07T05:31:56Z",
  "reactions": [
    {
      "emoji": "<string>",
      "member_id": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer token authentication using your API key

Path Parameters

chat_id

string

required

Chat ID

message_id

string

required

Message ID

tool_call_id

string

required

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.

type

enum<string>

required

Available options:

connection

connection_id

string

The connected connection id (con_...). Omit when declining an app.

declined_type

enum<string>

The app the person will not connect; its request resolves without a connection.

Available options:

SCHEDULER,

WORKFLOWS,

TOOLS,

FILES,

EMAILS,

HTTP_CREDENTIALS,

TABLES,

PAGES,

KNOWLEDGE,

SKILLS,

CONTACTS,

SEGMENTS,

ASSISTANTS,

AGENTS,

CHATS,

INBOX,

MEMBERS,

SUB_ORGS,

BILLING,

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

Example:

"SLACK"

Response

200 - application/json

The chat message schema

string

required

role

enum<string>

required

The role of the message

Available options:

user,

assistant,

system,

tool,

event,

note

model

string

required

The model used for the message

status

enum<string>

required

The chat status

Available options:

RUNNING,

COMPLETED,

FAILED,

CANCELED

created_at

string<date-time> | null

required

updated_at

string<date-time> | null

required

messages

object[]

The message content

System message

Show child attributes

member

object

The member of the chat

Show child attributes

error

string

Error message if the message failed

broadcast_id

string

ID of the broadcast this message originates from

is_broadcast_message

boolean

Whether this message was sent via a broadcast template

channel_type

enum<string>

The channel the message arrived through, if any

Available options:

internal,

org,

agent,

custom,

whatsapp_bot,

messenger_bot,

instagram_dm,

tiktok_dm,

telegram_bot,

slack_bot,

teams_bot,

gmail,

outlook,

twilio,

telnyx,

email,

smpp

usage

object

The usage information for the message

Show child attributes

cost

object

The cost of a message, at the rates it is billed at

Show child attributes

delivered_at

string<date-time> | null

When the message was delivered to the recipient

reactions

object[]

Emoji reactions on the message

Show child attributes

Respond to interactive tool

curl --request POST \
  --url https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "connection",
  "connection_id": "<string>",
  "declined_type": "SLACK"
}
'

import requests

url = "https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond"

payload = {
    "type": "connection",
    "connection_id": "<string>",
    "declined_type": "SLACK"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'connection', connection_id: '<string>', declined_type: 'SLACK'})
};

fetch('https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'connection',
    'connection_id' => '<string>',
    'declined_type' => 'SLACK'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond"

	payload := strings.NewReader("{\n  \"type\": \"connection\",\n  \"connection_id\": \"<string>\",\n  \"declined_type\": \"SLACK\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"connection\",\n  \"connection_id\": \"<string>\",\n  \"declined_type\": \"SLACK\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/chats/{chat_id}/messages/{message_id}/tools/{tool_call_id}/respond")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"connection\",\n  \"connection_id\": \"<string>\",\n  \"declined_type\": \"SLACK\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "role": "user",
  "model": "<string>",
  "status": "RUNNING",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "messages": [
    {
      "role": "system",
      "parts": [
        {
          "type": "text",
          "text": "<string>",
          "audio": {
            "id": "<string>",
            "file_path": "<string>",
            "file_filename": "document.pdf",
            "file_size": 1024,
            "file_mimetype": "application/pdf",
            "file_url": "<string>",
            "created_at": "2023-11-07T05:31:56Z"
          },
          "start_ms": 1,
          "end_ms": 1,
          "html": true,
          "json": true,
          "start_timestamp": 123,
          "end_timestamp": 123
        }
      ]
    }
  ],
  "member": {
    "id": "<string>",
    "role": "ADMIN",
    "user": {
      "id": "<string>",
      "name": "<string>",
      "avatar": "<string>"
    },
    "session": {
      "id": "<string>"
    },
    "contact_channel": {
      "id": "<string>",
      "type": "internal",
      "user_id": "<string>",
      "avatar": "<string>",
      "name": "<string>",
      "username": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "country": "<string>",
      "agent": "<string>",
      "ip": "<string>",
      "language": "<string>",
      "contact": {
        "id": "<string>",
        "name": "<string>",
        "blocked": true,
        "unsubscribed": true,
        "ai_replies": true,
        "is_admin": true,
        "segments": [
          {
            "id": "<string>",
            "name": "<string>",
            "color": "red",
            "contacts_count": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "link": "<string>"
    },
    "agent": {
      "id": "<string>",
      "name": "<string>",
      "icon": "<string>",
      "color": "red",
      "shape": "square",
      "avatar_url": "<string>"
    },
    "seen_at": "2023-11-07T05:31:56Z"
  },
  "error": "<string>",
  "broadcast_id": "<string>",
  "is_broadcast_message": true,
  "channel_type": "internal",
  "usage": {
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123,
    "reasoning_tokens": 123,
    "input_tokens_cache_read": 123,
    "input_tokens_cache_write": 123,
    "turns": [
      {
        "input_tokens": 123,
        "output_tokens": 123,
        "total_tokens": 123,
        "reasoning_tokens": 123,
        "input_tokens_cache_read": 123,
        "input_tokens_cache_write": 123
      }
    ]
  },
  "cost": {
    "total": 123,
    "base": 123,
    "lines": {
      "input": 123,
      "output": 123,
      "reasoning": 123,
      "cache_read": 123,
      "cache_write": 123
    }
  },
  "delivered_at": "2023-11-07T05:31:56Z",
  "reactions": [
    {
      "emoji": "<string>",
      "member_id": "<string>"
    }
  ]
}

Getting Started

Inbox

Chats

Messages

Contacts

Custom channels

Segments

Suppressions

Assistants

Agents

Skills

Knowledge

AI

Broadcasts

Email sending

WhatsApp

WhatsApp Meta agent

Tables

Records

Views

Pages

Connections

Workspace

Sub-organizations

Analytics and logs

Respond to interactive tool

Authorizations

Path Parameters

Body

Response