Zorp Docs
Search…
⌃K

Rest API Action

REST API action is the used to integrate Zorp with any other system through REST API format.
This system could be your internal system or any 3rd party system.

Creating a REST API Action

Like other actions, REST API action can also be created from the workflow transition.
  1. 1.
    Select any transition
  2. 2.
    In the Actions block, click on Add Action
  3. 3.
    Select Rest API Action
  4. 4.
    Provide a suitable name for the REST API action
  5. 5.
    Choose the HTTP Methods (GET, POST, PUT, PATCH, DELETE)
  6. 6.
    Provide a valid http or https url
  7. 7.
    Any HTTP headers that should be passed along can be added in the Headers section
  8. 8.
    Payload or body can be added from the BODY tab
    • Only JSON format is accepted
    • Needs to be a valid JSON object
    • Body json can contain dynamic data field variables
    • You can also use the Low Code editor and programatically construct the payload for the REST API. Check more about this in Low Code Scripting
  9. 9.
    Configured REST API action can be instantly tested for correctness from Action Response tab
    • Along with testing the configured API, you can also add the response of the API to the mock data
    • Update mock data will come in handy while low code testing

Edit a REST API Action

Editing a REST API action is similar to creating a new one. Navigate to the specific transition and double-click on the action to edit.

Deleting a REST API Action

Deleting a REST API action can be done from action list of the transition