On the Web URLs page, you can create a new WebURL or view existing WebURL records.
Menu path: System Administrator > Webhook > Web URLs
The table shows the columns that provide essential information about each WebURL at a glance. You can customize the columns according to your needs from the table settings.
Click New to create a new WebURL. You can also edit an existing WebURL by clicking Edit in the action menu, or delete a WebURL record by clicking Delete.
On the WebURL page, you can make requests to web services using the GET, POST, PUT, and DELETE methods.
The Variables section contains informative content about the functions and variables you can use.
Methods
GET
Used to retrieve data from the server.
It is the most commonly used HTTP method.
Parameters can be sent in the URL.
Example: https://www.google.com/search?q=cat
POST
Used to send data to the server.
It is used to create new data or update existing data.
Data is usually sent in the request body.
Example: https://api.example.com/users
PUT
Used to update an existing resource.
It is used to update the entire resource.
Data is usually sent in the request body.
Example: https://api.example.com/users/1
DELETE
Used to delete a resource from the server.
The ID of the resource to be deleted is specified in the URL.
Example: https://api.example.com/users/1
Params
This section allows you to customize API requests. You can add multiple parameters by clicking the Add Parameter button. You can change the order of the parameters using drag and drop.
Field | Description |
Key | The name of the piece of data expected by the API. For example, if you want to send a user's name, the key might be "username". |
Value | The actual piece of data corresponding to the key. For the "username" key, the value would be the actual user's name (e.g., "john.walker"). |
Description | A text explaining what the parameter is for. It is optional but can help you understand what the parameters represent. |
Authorization
This section lists options based on the authentication names previously created on the WebURL Authentication page. When you select an authentication name from the list, the name of the related authorization method is displayed below it.
The authorization feature is used as an authentication method to control access to the API. The basic working principle of Web URL Authorization is as follows:
The client sends a request to access the API.
The API directs the client to a Web URL for authentication.
The client enters their credentials (such as username and password) on the Web URL.
The Web URL verifies the credentials and sends an authentication token to the client.
The client uses the authentication token to access the API.
Headers
You can use the headers section to add headers to API requests and responses. Headers are used to send additional information to the API and receive additional information from the API.
Field | Description |
Key | The name of the piece of data expected by the API. For example, if you want to send a user's name, the key might be "username". |
Value | The actual piece of data corresponding to the key. For the "username" key, the value would be the actual user's name (e.g., "john.walker"). |
Description | A text explaining what the parameter is for. It is optional but can help you understand what the parameters represent. |
Body
The body of an HTTP request contains the data sent to the server. This data can be in various formats. Web URL body use cases:
Form Submission: Used to send the data from input forms to the server.
API Requests: Used to send data to APIs.
File Uploads: Used to upload files to the server.
The following body types are available:
Type | Description |
None | No data is sent in the request body. It is used in situations where sending data is not necessary, such as simple GET requests. |
Form-Data | Similar to the data submission format used in web forms. It is used to send data as key-value pairs. When the form-data type is selected, the interface requires you to fill in separate fields for each key and value. |
x-www-form-urlencoded | Similar to the form-data type, it is used to send data as key-value pairs. However, unlike form-data, the data is sent in URL-encoded format. This format might be preferred by some older APIs. |
Raw | Used to send raw data without any format restrictions. You can send data in different formats such as JSON, XML, text, or binary data. When the raw type is selected, you need to enter the desired data in the request body in the interface. |
Response Manipulation
Web URL Response Manipulation is a technique used to modify responses from a web server. It can be used for various purposes, as shown in the examples below.
Response Manipulation examples
Formatting Responses: Response Manipulation can be used to transform a JSON response from a web server into an HTML table.
Hiding Sensitive Information: Responses from a web server can be manipulated to hide sensitive information, such as credit card numbers or social security numbers.
Testing Responses: Response Manipulation can be used to generate different error codes or response bodies to test web applications.
Test
The Web URL test module is a tool used to test the functionality of a web page or web API. It works by sending HTTP requests to a web server and analyzing the responses.
Response section
The Web URL Response section displays information about the response received from the web server. This section includes the following information:
Status Code: A code indicating the success of the HTTP request. For example, the 200 OK code indicates that the request was successful.
Headers: Additional information sent by the web server. For example, the Content-Type header indicates the type of the response.
Body: The actual data received from the web server.
