Plugin Overview

• The Bean Shell API Element allows you to create arbitrary endpoints in API Builder that execute Bean Shell scripts.
• BeanShell API Element plugin requires API Builder installed on at least Joget DX Version 8.
• The published API endpoint is publicly accessible for GET and POST request methods.
• When sending a successful response, your BeanShell script should return org.json.JSONObject that includes a "data" JSON key, which contains the primary data for the response payload.
• The "data" JSON key may contain either org.json.JSONObject or org.json.JSONArray.
• For a customized successful response, you will need to provide the "code" and "data" JSON keys.
• When sending an error response, you may provide a custom error message using the "message" JSON key. The "data" JSON key will be ignored.

Versioning

8.0.0 | Date Released: 12 September 2025