Skip to main content

Authenticated REST calls

Current configuration of the Authenticated REST call task in the Workflow Designer

The Authenticated REST call task executes an HTTP request to an external service. It supports anonymous requests, Basic or Bearer authentication, custom headers, request body, and proxy.

Configuration

FieldDescription
SSL ConnectionIndicates whether to use a secured connection.
ProxyUses system settings, no proxy, or a custom proxy.
Proxy addressRequired only when choosing a custom proxy.
URLService address. Can contain dynamic workflow parameters.
AuthenticationNone, Basic, or Bearer.
User and PasswordCredentials required by Basic authentication.
TokenCredential required by Bearer authentication.
MethodGET, POST, or PUT.
HeaderJSON list of headers to send.
BodyRequest body; not applicable for the GET method.

Headers are represented as a list of strings:

[
"Content-Type: application/json",
"Accept-Language: it-IT"
]

Sybot parameters can be used in the body. In this example, values come from previous tasks:

string:{
"documento": "#>document_name<#",
"stato": "#>document_status<#"
}

Do not enter credentials directly into headers or body when dedicated authentication fields are available. Also, avoid reporting passwords, tokens, or sensitive content in task names and messages intended for logs.

Results

The task makes available:

  • the response headers and body;
  • the HTTP status code;
  • the operation outcome;
  • the structured execution summary.

Use the HTTP code and response content under the following conditions. A 2xx code normally indicates an accepted request, while 4xx and 5xx codes require handling the error defined in the workflow.

Verification

Initially execute the call with synthetic data and check the method, response code, and any diagnostic message in Logs. Sensitive data must not be copied into variables intended for notifications or public files.