Login
Updated on November 3, 2026

Configuration

Estimated reading: 4 minutes

The Configuration module acts as the primary bridge between your platform and external systems, services, or third-party applications. It utilizes REST APIs to facilitate a two-way flow of information, allowing your application to send requests and process responses efficiently.

Core Objectives

Utilize this feature when your integration requires:

1. Data Retrieval: Fetching information from external services.
2. Data Submission: Sending data to systems for processing.
3. Record Management: Creating, updating, or deleting records in third-party databases.
4. Workflow Orchestration: Triggering external business processes, automated workflows, or notifications.
5. System Synchronization: Maintaining data consistency across multiple platforms.

Key Components of an API Request

Every API request consists of the following structure:

a. API Protocol: The communication standard used.
b. HTTP Method: The action to be performed (e.g., GET, POST).
c. Endpoint URL: The destination address for the request.
d. Request Headers: Metadata for authentication and content types.
e. Query Parameters: Key-value pairs appended to the URL.
f. Request Body: The data payload sent with the request.
g. API Response: The information returned by the external system.

HTTP Methods

GET (Retrieve Data)

Used strictly to fetch data without modifying existing records.

Characteristics: Read-only, safe, typically uses query parameters.

Example URL: https://api.example.com/employees?employeeId=1001&status=Active

POST (Submit Data)

Used to send data for processing, creating records, or initiating actions.

Characteristics: Often modifies state; requires a request body payload.

Example Payload: json {  “employeeId”: “1001”,  “employeeName”: “Hana”,  “department”: “IT”}

Comparison Summary

Feature GET POST
Primary Purpose Retrieve information Submit information
Data Modification No Yes
Request Body Typically not used Commonly used
Record Creation No Yes

Validation with “Invoke”

The Invoke feature is essential for testing your configuration before saving it to a workflow. It validates:

a. Endpoint connectivity.
b. Authentication settings and headers.
c. Query parameter and payload structure.

A successful response confirms that your configuration is correct, and the external system has processed the request successfully.

Configuration Steps

1. Endpoint URL

Enter the full API path.
Eg: https://api.example.com/v1/tests

2. Content Type

Defines the format in which data is sent in the request body

Request Body Types

Type Description Media Type When to Use Example
None No body is sent with the request. N/A Use for GET requests that only retrieve data without submitting information. —
JSON Data is structured in JSON format. application/json Use when sending structured data to modern APIs. This is the most commonly used content type. { "name": "John", "age": 30 }
XML Data is structured in XML format. application/xml Use when the API expects XML, commonly found in legacy or enterprise applications. <user><name>John</name></user>
FormData Data is sent as multipart form fields or files. multipart/form-data Use when uploading files or attachments together with form data. File + form fields together
UrlEncoded Data is sent as simple key-value pairs. application/x-www-form-urlencoded Use for standard HTML form submissions without file uploads. name=John&

3. Request Headers

Request headers are key–value pairs sent along with an HTTP request to provide additional information about the request. They are commonly used for authentication, content type specification, API keys, client identification, and response formatting. Each header contains a unique key (such as Content-Type) and a corresponding value (such as application/json) that helps the server process the request correctly.

Technical Format: Key: string, Value: InArgument
Example: Content-Type → “application/json”

4. Query Parameters

Query parameters are key-value pairs added to the end of a URL in an HTTP request. They let you pass extra information to the server, such as filters, search terms, page numbers, sort options, or other optional request details.

Format: Add them to the URL using a question mark ?, followed by one or more parameters separated by &.
Example: https://api.example.com/tests?status=active&limit=10

Note: Think of these as extra instructions. For example, status=active tells the server to return only active items, and limit=10 tells the server to return only 10 results.

5. Invoke & Response

1. Click Invoke to execute the API request.
2. Once the request is completed, the API response will be displayed.
3. You can either:
Copy the response directly, or
Assign the response to a variable for further use in the workflow.
4. In the Assign tab, use apiResponse.data to access the response data returned by the API.

Best Practices

1. Method Selection: Use GET for data retrieval and POST for data creation or submission.
2. Reachability: Ensure the endpoint URL is valid and accessible.
3. Authentication: Configure all required authentication headers (e.g., Bearer tokens) before testing.
4. Testing: Always use the Invoke option to verify your configuration before deploying to production.

Next - UI Recorder Recorder Page
Share this Doc

Configuration

Or copy link

CONTENTS

Powered By Sutherland

Robility Chatbot
Robility Assistant
Online