Skip to end of metadata
Go to start of metadata

Introduced in v5, the API Domain Whitelist setting in General Settings needs to be configured to allow JSON API requests. If a request is from a non-whitelisted domain, the response will be a HTTP 400 Bad Request.




  • Under wflow-plugin-base module

  • Interface for Web Service Plugin

Method Detail

Interface Methods

public void webService(javax.servlet.HttpServletRequest request, javax.servlet.HttpServletResponse response) throws javax.servlet.ServletException,

Work similar to a Servlet.

URL Pattern 

{Context Path}/web/json/plugin/{Plugin Class Name}/service

  • Example: http://localhost:8080/jw/web/json/plugin/org.joget.sample.lib.SimpleFormElement/service?say_something=Hello World

{Context Path}/web/json/app/{App Id}/{App Version}/plugin/{Plugin Class Name}/service

  • Example: http://localhost:8080/jw/web/json/app/crm/1/plugin/org.joget.sample.lib.SimpleFormElement/service?say_something=Hello World
  • This pattern allowed you to retrieve app definition in your implementation by using this code:
AppDefinition appDef = AppUtil.getCurrentAppDefinition();

Plugin Properties Options

  • Does not support.


Related Community Plugins

  • Department Permission
    org.joget.apps.userview.lib.DepartmentPermission (wflow-core)
  • Email Tool (wflow-core)
  • Group Permission
    org.joget.apps.userview.lib.GroupPermission (wflow-core)
  • Inbox
    org.joget.apps.userview.lib.InboxMenu (wflow-core)
  • Organization Permission
    org.joget.apps.userview.lib.OrganizationPermission (wflow-core)
  • Run Process
    org.joget.apps.userview.lib.RunProcess (wflow-core)
  • Subform
    org.joget.apps.form.lib.SubForm (wflow-core)
  • User Notification (wflow-core)
  • User Permission
    org.joget.apps.userview.lib.UserPermission (wflow-core)


  • No labels