Description
The Rest sender plugin sends messages by posting to an http/https url. JSON format is supported.
Prerequisites
Installation
Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.
1 - Login
Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).
2 - System Maintenance
Click on the menu icon and choose the option "System maintenance"
3 - Upload file
In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.
4 - Restart
After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.
Configuration
Open the main menu and click on "New plugin"
Select the plugin you want to configure. Use the Filter field if needed.
The REST sender does POST requests to a configured endpoint. Optionally, basic authentication or a header can be added.
Field name | Supported values | Description |
|---|
Target url | Any string | Endpoint to which send the JSON content |
Message branch | Any integer | Indicates what part of the message to send |
| Username for basic authentication | Any string | (Optional) Http basic authentication user |
| Password for basic authentication | Any string | (Optional) Http basic authentication password |
| Header | Any string | (Optional) Header name to send in the request |
| Header value | Any string | (Optional) Header value to send in the request |
| Send content as array | true / false | Defines if the JSON to send starts off with an array or an object |
See also