Input and Output data format

All the data returned by your server in successful requests (having a 200 HTTP status code) must be formatted as a JSON object.

The exact data to be returned in each case is detailed in each command description.

Input parameters for the commands are sent from Botize in the query string (for GET requests) or as part of the request body (for POST requests). There are two parameters that are always sent for all commands: one that indicates the target application name (so that you can use one single entry point URL for multiple applications), and one that indicates the name of the command to execute. More parameters will be required depending on the command being invoked.

Some commands require fairly complex data to be supplied by Botize. In these cases, the data is encoded as a JSON object and sent in a parameter whose name is always “data”.

See the Commands reference section for more details.