General information about Requests widget
The widget is one of the main builder module, it allows you to completely customize the behavior of the HTTP request for each entity.
In entity, there can be an unlimited number of widgets, for example, when you need to make two requests in a row to create (something) in the system. Either when the trigger receives an event on the webhook, but then you need to make an additional request to the system to get all the information about the event.
The widget consists of:
Request tab configures an outgoing request. This tab is to specify the URL where the request is sent, the request method, the content type, and link the "Authorization". You can also add headers and parameters (request body).
Response tab sets up the parser for the response to the request. For example, when you need to get the ID of the entity created in the system, or when a search request occurs and you need to get the fields of the found entity. It is also the main tab in triggers.
Errors tab sets up error handling for this request. The application does not know which requests are erroneous and which are not. In this tab, you can configure matches with the filter, that means when the data in the response matches with the filter, the transaction in Albato will be considered erroneous. It is also possible to configure the mapping of the error message. If the API system sends an error text in the response, then the mapping to this variable will display the text in the bundle log (in case of an error).
In the widget, you can use both static values and dynamic variables (e.g., Trigger / Action / Authorization), dynamic variables will place the value that will be passed directly in the fields that the user fills.
The selection of the fields that fall into the value occurs through a special “Smart field” block, in which fields created in the entity are displayed.
In entity, there can be an unlimited number of widgets, for example, when you need to make two requests in a row to create (something) in the system. Either when the trigger receives an event on the webhook, but then you need to make an additional request to the system to get all the information about the event.
The widget consists of:
Request tab configures an outgoing request. This tab is to specify the URL where the request is sent, the request method, the content type, and link the "Authorization". You can also add headers and parameters (request body).
Response tab sets up the parser for the response to the request. For example, when you need to get the ID of the entity created in the system, or when a search request occurs and you need to get the fields of the found entity. It is also the main tab in triggers.
Errors tab sets up error handling for this request. The application does not know which requests are erroneous and which are not. In this tab, you can configure matches with the filter, that means when the data in the response matches with the filter, the transaction in Albato will be considered erroneous. It is also possible to configure the mapping of the error message. If the API system sends an error text in the response, then the mapping to this variable will display the text in the bundle log (in case of an error).
In the widget, you can use both static values and dynamic variables (e.g., Trigger / Action / Authorization), dynamic variables will place the value that will be passed directly in the fields that the user fills.
The selection of the fields that fall into the value occurs through a special “Smart field” block, in which fields created in the entity are displayed.
Updated on: 01/12/2022
Thank you!