Adding JSON API blocks to dialogue

Build offers JSON API integration blocks that can be used to send https GET and POST requests at any time during a dialogue flow.

To add a JSON API block into your dialogue click on the blue button to create a new event.

Select  "JSON API" from the side menu.

In the URL field of the JSON block enter the URL endpoint using the curly bracket variable to represent the target variable for which the API is purposed to retrieve.

In the header field enter the HTTP header that is being used for the request. Authentications such as user token should also be filled in to this section if needed.

The JSON body only works when using POST methods. Save the response of the call to the variable with the name defined in this field i.e. if a response returns JSON data object {capital: ‘Ottawa’, currency: ‘CAD’} and “result” was entered in the “Save as” field then the curly brackets syntax is used to access {result.capital} and {result.currency} to display the data in other blocks within the dialogue structure.

You can use the “Success” and “Fail” Panel to setup the action after API response.


Save the block once all the fields have been input.

Adding JSON API blocks to dialogue
Adding JSON API blocks to dialogue
Adding JSON API blocks to dialogue
Adding JSON API blocks to dialogue

Sammy is the Head of Engineering at Proto. He specializes in backend development and cloud infrastructure. To reach Sammy, please write to him at sammy@proto.cx.