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, PATCH or DELETE.
• URL — may contain placeholders such as https://api.example.com/orders/{orderId}.
• Parameters — each with a name, a type (string, number or boolean), a description and whether it is required.

How the request is built

1. Parameters named in the URL fill their {placeholders}.
2. The rest go in the query string for GET and DELETE, or as a JSON body for the other methods.
3. The bot receives the status code and up to 10,000 characters of the response.

Tools belong to the workspace; attach one to every bot that should use it. The Tools API does the same over REST.