Basics

Robobot aims to deliver a developer friendly approach for integrating conversational forms, created through the Robobot Dashboard, in existing software products.

HTTP Methods

Robobot API can be integrated easily with any existing HTTP client using a variety of programming languages and frameworks. The API currently only supports POST requests that need some headers for authentication and formatting purposes.

JSON

All Robobot API endpoints return JSON formatted data. POST actions need to be provided JSON formatted request bodies. These bodies should follow a schema as provided by the API reference.

Please note that we require each POST request to include the HTTP header Content-Type with its value set to application/json.

curl "https://api.robobot.app/client/entry/submit/<form_id>" \
    -X "POST" \
    -H "Content-Type: application/json"

Super-powers are granted randomly so please submit an issue if you're not happy with yours.

Authentication

Robobot API has a custom authentication mechanism. It involves including a non-default HTTP header named "ApiCode" with your API requests. Provide your personal ApiCode formatted as xxxx in this header to open up requests to your forms. Use the "AccessCode" header and populate it with an accesscode to group answer data. We call grouped answers an entry.

An example of a curl request could look like this. Make sure to replace the XXX...X with your obtained access code and provide a form_id. Dive into the API reference to see how you generate your own access code.

curl "https://api.robobot.app/client/entry/submit/<form_id>" \
    -X "POST" \
    -H "Content-Type: application/json" \
    -H "ApiCode: xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx"
    -H "AccessCode: XXXXXXXXXXXXXXX"