Blocworx Documentation
  • Welcome to Blocworx
  • The structure of Blocworx
    • What is a project?
  • Getting Started
  • How To's
    • How To's
      • Get Started: Build a Simple Module
      • Build a simple invoicing system
  • Page
    • Page Overview
      • Page Sections
      • Modules in Pages
      • Sub Pages
      • URL Links
    • Edit a Page
    • Manage Pages
  • Module
    • Module Overview
      • Module Sections
      • Blocs in Modules
      • Automated Reports
    • Module Editor
      • Add, remove and move Sections and Blocs
      • Edit Module Location & Icon
      • Edit Module Details
      • Import from another Module
      • Delete a Module
      • Make this module available to child instances
    • Manage Modules
  • Bloc
    • Bloc Overview
    • Bloc Front End Overview
      • Data Display
      • Advanced Reports
    • Bloc Editor Overview
    • Pdf & Doc File Template Builder
    • The Blocworx Process Flow
    • Edit Templates
  • Bloc Editor
    • Bloc Form Builder Preview
    • Fields, Tools and Charts
      • Standard Input Fields
        • QR Code
        • Text
        • Large Text Field
        • Checkbox
        • Multi Button
        • Dropdown from List
        • Date/Time Selector
        • Bluetooth (Beta)
        • Button
      • File & Image Fields
        • File Field
        • Multi File Field
        • Image URL Field
      • Linked Data Selection Fields
        • Dropdown from Bloc
        • Autocomplete
        • Radio Buttons From Bloc
        • Checkboxes From Bloc
        • Link Data Field
      • Content Editing Components
        • HTML Field
        • Separator Field
        • Content Editor For User (WYSIWYG)
        • Content Editor (WYSIWYG)
      • User Based Components
        • Create User Pop Up
        • Logged in Users Information
        • User Select Field
        • Signature & Authentication
      • Dynamic Output & Variable Components
        • Time/Date Difference
        • Auto Generate Field
        • Plain Data Field
        • Maths Field
        • Field Merge Builder
        • Label Field
        • Barcode Generator
      • Third Party Integration Components
        • Blocworx Gateway
        • Bartender Integration
        • File Builder
        • Mindee API
      • Charts, Results & Data Feeds
        • Local Data Doughnut Chart
        • Advanced Chart Set 1
        • Results Box
      • Sub Blocs, Tools & Components
        • Submit Button
        • Sub Bloc
        • Cross-Bloc Data Manipulator
        • Bloc List
        • Mail Alert
        • Calendar & Resource Planning
    • Field Create, Edit, Parameters, Rules and Actions
      • Creating a Field
      • Editing a Field
      • Field Parameters
        • Choose hidden options for this field
        • Mobile Configurations
        • Rule and Actions Based Parameters
        • Main Field Parameters
        • Conditional Value
        • Set Character View Limit
        • Conditional Visibility
        • Dynamic Data Update (Update Value Based On Another Date Field)
        • Field Names in Different Languages
        • Manage Field Actions
        • Load Data from Another Bloc
      • Field Rules and Actions
        • Can not be empty
        • Must Be Equal To
        • Cannot Be Equal To
        • Must be Between Two Values
        • Must be at least X number of characters
        • Must be exactly X number of characters
        • Item must have been entered elsewhere
        • Item must not have been entered elsewhere
        • A specific value is required elsewhere
        • A specific value cannot be present elsewhere
        • Populate another local field with data from elsewhere
        • Populate another local field with total from elsewhere
        • Max Allowed Duplicates
        • Can only be numbers/integers
        • Keep Data for Next Entry
        • Must be Certain Format
        • Cannot be Equal Another Local Field
        • Must be equal to another local field
        • Populate another local field with part of this field
        • Populate local field with data from another local field
        • Must have matching equivalent data in another form
    • Bloc Settings
      • Main Bloc Settings
      • Functional Behaviour Settings
      • Bloc Layout and Visibility Settings
      • Data Display Settings
      • User Restricted Data Settings
      • Manage and Build Templates
      • Bloc, User and Role Access
      • List of available Field Slugs
      • Manage Bloc Scheduler
  • Manage Data
    • Manage Data Overview
    • Raw Data and Counting Reports
    • Look Up/Edit Data
    • Find and Replace Data
  • Administration
    • Admin & Development Overview
    • Manage Users
      • Profile Filter
    • Roles & Permissions
      • Roles
      • Permissions
    • Manage Mail Alerts
  • App Settings
    • Sign In With Google
    • Timeout Setting
  • No Code Development
    • Manage Blocworx Instances
      • Parent and Child Instances
    • Edit Theme
    • Manage Modules
    • Manage Pages
    • Extra and Beta Features
Powered by GitBook
On this page
  • Initial Field Parameters
  • An example of how to build the gateway API to translate texts.

Was this helpful?

  1. Bloc Editor
  2. Fields, Tools and Charts
  3. Third Party Integration Components

Blocworx Gateway

PreviousThird Party Integration ComponentsNextBartender Integration

Last updated 1 month ago

Was this helpful?

The Blocworx Gateway Field is designed to send requests to API and then use the response in the bloc. This is useful for gathering information to fill fields in the bloc.

The default behavior is when the Blocworx Gateway field is triggered, a POST request of multipart/form-data will be sent to the API.

Initial Field Parameters

Parameter
Description

Gateway URL

This is the URL of the API.

Send your current Auth Token with the request

If this field is selected the authenticated user's token will be sent in the request.

Show the original response from the API in the browser console

Tick if you want to see the original API response and not the blocworx response.

Select GET or POST

This option is to change the request action.

Choose when trigger the gateway

This option is to choose when to trigger the request. The current options are when submitting the form, editing a field, or manually using a created button.

Choose actions with the response

The current options are to populate the fields in the form using the data of the API response and to trigger rules on populated fields.

Field to Trigger the request

This option is to choose which fields in the bloc will trigger the request to the API.

Select Frequency

If the 'Run On Schedule' trigger option is selected above, you can use this dropdown to select how often you want to trigger the request.

Blocworx Gateway Conditions (local field and value to compare)

These are the conditions that must occur in order to trigger the request. It uses the value in the local field (the field on the bloc you are on) and compares it to the value entered based on the condition chosen.

Add Header

This option is to enable the user to include any necessary header with the request. It is possible to choose between a set of pre-defined options and type the desired value.

Body Request

This allows the user to specify a Body to send custom information with the Request

An example of how to build the gateway API to translate texts.

In the gateway URL, write the endpoint of the API. e.g.

Choose if the action is a post or a get

Choose when the gateway is triggered, in this example, we are using a button to do it. It's also possible to choose the name and color of the button.

Add headers that are required to call the API properly. e.g. content-type: application/JSON.

You may add as many headers are necessary to call the API properly.

Finally, add the request body that is going to be sent using the gateway API.

e.g. [{text: [BW]Text[/BW]}].

In the request body field, the user should use the pattern [BW]field_slug[/BW] that will be changed to the value in the chosen field before calling the API.

It's possible to click in the desired field that shows when you click in "Click to view fields to add" and the pattern will be automatically added to the request's body.

https://microsoft-translator-text
Example of gateway URL
Example of request action
Example how to trigger the gateway API
Example of Header
Example of the Request's Body