Configuration

This section explains each of the properties in the configuration blade.

General

PropertyDescription

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.

Service Details

PropertyDescription

Use Variables

Tick to use variables for Base Url.

Base Url

The base URL of the API server.

e.g. http://api.weatherstack.com/

Metadata File

The metadata configuration file includes the operations available, their operations, and the output schema of the operations.

Refer to Metadata File Configuration for more information.

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 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).

Operation

PropertyDescription

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.

Before configuring the Action Agent, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.

Input Mapping

The properties grid is populated an operation is selected.

PropertyDescription

Parameter

The parameter specified in the uploaded metadata JSON file.

Value

The column or attribute from the input payload that is used as the parameter value sent to the Rest API operation.

Endpoints

PropertyDescription

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.

Last updated