Configuring Action

Actions push or put new data into apps through API calls that pass data from user customized input fields. Configuring actions can be required in the following cases:

• create new items in an app

• update existing items with a create action

• find existing items in an app with search actions

Actions are of 2 types:

1. Create: add new data to your app

2. Search: finds data in apps and optionally create new items if the search returns no results

Before you start

• You should have a configured app.

How it works

1. From your Partner Dashboard

2. Go to App. All your created apps will be visible on this page.

3. Select a created app.

4. You will be redirected to the App detail page.

5. Click on the Extension page.

6. Click on Actions tab and click Add Action.

7. Fill in the core details:

   1. Type: type of action

   2. Key: A unique identifier for this action

   3. Name: A human friendly plain text name for this action

   4. Noun: A single noun that describes what this action 

   5. Description: A plain text sentence that describes what your action does to help users understand why they should use this action

   6. Visibility Options: An option to select when this action will be shown.

      1. Important : shows the action by default which in App’s action list.

      2. None: Choose None if you want this action hidden by default

      3. Hidden: choose Hidden if this action should not be shown to users

   7. Enable create if not found: This field is only visible in case the type of action is Search. Check this checkbox if you wish to pair this action with a Create action if not found while searching. On checking this checkbox, new field will be visible:

      1. Create Action : Choose an Action that will create this object from the list of existing Create actions.

      2. Click on Save and continue.

8.  Input Designer will open to build the input form field for your action. Add all the required fields in input designers that your API will require to create, update or search app.

   1. Click on Save and continue.

9. Enter API configuration.

   1. Enter url where Eshopbox will make request and send input data.

   2. Enter type and body.

   3. Enter output json of your API.

   4. Click on Save and continue .
      NOTE: You can turn your form mode to code mode. Click the Switch to Code Mode to write a custom API call in JavaScript code.

10. Test your API request: Once your API call is added, test it inside visual builder with testing data.

    1. Test your Authentication Configuration: Select your auth account for testing. Authenticate with your app if you haven’t already.

    2. Then fill in each input field under the Configure Test Data section with data(input fields) that will work in your app.

    3. Click Test Your Result

    4. Click Finish testing and continue.

11. Define your Output: Steps to define sample output data.

    1. Sample Data: Enter JSON-formatted sample output data for the most commonly used fields from this Trigger to use in APP as sample data if users don’t test it.

    2. Click on Generate output field definitions.

    3. Output Fields: On click Generate output field definitions. A table gets created with key-value pairs as mentioned in the sample data. (NOTE* You can Add user-friendly names for the most popular fields from API output data). The Type of the value is auto-detected, you can change if we have incorrectly detected it.

12. Click on Save and continue.

Reference doc: https://platform.zapier.com/docs/actions

Reference for UI:

Core Settings:

API Configuration:

Screenshots for reference:

Open

Open

Open

Open

Open

Open