Build an integration

Canvas objects

Response object

We expect a canvas object in response to the request. This is where you'll specify the UI for the first screen of the app using components.

Canvas

You have to always respond to requests with a canvas object. This will tell us what UI to show for your app.

A canvas needs a content object which will contain the components to show and may optionally contain a stored_data object to pass key-value pairs of data that you want to be sent in whatever the next request is.

{
  "canvas": {
    "content": {
      "components": [
        {
          "type": "text",
          "text": "This is a text component."
        }
      ]
    },
    "stored_data": { "key": "value" } // Optional. Can be more than one pair
  }
}