Configuration
Last updated
Last updated
This section explains each of the properties in the configuration blade.
Collection
This associates this Agent to a specific Collection and defaults to that of the current Data Stream.
Visit Collections and Stream Hosts to understand more about Collections.
Use Variables
Tick to use variables for Base Url.
Base Url
The base URL of the API server.
Metadata File
The metadata configuration file includes the operations available, their operations, and the output schema of the operations.
Use Authentication
Tick to provide REST API Authentication details; or connect to the REST API anonymously.
Authentication Type
The authentication methods supported are: (applies when Use Authentication is ticked)
Basic
Bearer Token
Custom Header
OAuth2
Username
The username required to access the API (applies to Basic Authentication Type only).
Password
The password required to access the API (applies to Basic Authentication Type only).
Bearer Token
The token for accessing the API (applies to Bearer Token Authentication Type only).
Custom Header Key
The HTTP header key is added to the request headers (applies to Custom Header Authentication Type only).
Custom Header Rest Request
Tick this to use a separate Rest request to supply the Custom Header Value, or leave unticked to manually enter or select a variable containing a pre-generated value.
Custom Header Value
The HTTP header value is added to the request headers (applies to Custom Header Authentication Type only).
Authentication Endpoint
The endpoint where the agent sends a request to retrieve the token(applies to OAuth2 Authentication Type only). This will vary depending on your app.
Below are some sample endpoints from popular providers:
Google: https://accounts.google.com/o/oauth2/auth
Microsoft Azure Active Directory: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/authorize
ClientId
The HTTP header key added to the request headers which also serves as a public identifier of your app (applies to OAuth2 Authentication Type only).
ClientSecret
The HTTP header key added to the request headers which is a secret known only to the application and the authorization server (applies to OAuth2 Authentication Type only).
Scope
The HTTP header value added to the request headers (applies to OAuth2 Authentication Type only). This is an optional field as some provider(Microsoft) requires it.
Accept
The HTTP header value added to the request headers, indicating which content type the client is able to understand (applies to OAuth2 Authentication Type only).
Refresh Client Token Interval (hours)
A timespan between 1 (default) and 24 hours to specify how often should the Agent refresh the OAuth client token (applies to OAuth2 Authentication Mode only).
Header Request Method
The HTTP method type of the Rest request that will fetch the Custom Header value (applies to Custom Header Authentication Mode, and only when Custom Header Rest Request is ticked). Options are:
Get
Post
Put
Header Request Url
The Url from which to request the the Custom Header value (applies to Custom Header Authentication Mode, and only when Custom Header Rest Request is ticked).
Header Request Body
The body (if any) of the Rest request that will fetch the Custom Header value (applies to Custom Header Authentication Mode, and only when Custom Header Rest Request is ticked).
Path to Header Value
The JSON path describing where in the response the Custom Header value will be found (applies to Custom Header Authentication Mode, and only when Custom Header Rest Request is ticked).
Operation
The operation to be performed. The list is populated from the uploaded metadata configuration file.
Result Entity
The entity against which the operation is performed (applies when reponseSchema is specified in the metadata JSON file). The list of entities is populated from the uploaded metadata configuration file.
Result Path
The JSON path at which the single object or array of objects to be output will be found in the response. The list of possible paths is populated from the uploaded metadata configuration file.
Before configuring the Action Agent, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.
The properties grid is populated an operation is selected.
Parameter
The parameter specified in the uploaded metadata JSON file.
Mapping
The column or attribute from the input payload that is used as the parameter value sent to the Rest API operation.
Value
The raw value to be used as the parameter value sent to the Rest API operation. If a non-empty Value is entered, it will override any Mapping value entered into the same row.
Input
This endpoint is used to receive data from the parent Agent.
Output
The record from the selected result entity combined with the data received from the parent Agent.
Error
If errors are encountered during the execution of this Agent, they will be published on this endpoint.
e.g.
Refer to for more information.
