HTTP tools
When a service has no plugin, describe a single HTTP request and the bot can call it. Open the plugin catalogue and choose Custom HTTP tool under Your own.
A tool is:
- Name and description — the description tells the bot when to use it.
- Method —
GET,POST,PUT,PATCHorDELETE. - URL — may contain placeholders such as
https://api.example.com/orders/{orderId}. - Parameters — each with a name, a type (
string,numberorboolean), a description and whether it is required.
How the request is built
Section titled “How the request is built”- Parameters named in the URL fill their
{placeholders}. - The rest go in the query string for
GETandDELETE, or as a JSON body for the other methods. - The bot receives the status code and up to 10,000 characters of the response.
Tools belong to the workspace. Every bot gets every tool the role of the person it
works for may use: GET tools by default, other methods once a role is given
write. See the Tools API.