Versions Compared

Version Old Version 2 New Version 3
Changes made by

Zoe Baldwin

Zoe Baldwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue

Email Endpoints

Insert excerpt
Setting up an API EndpointSetting up an API Endpoint
nameOverview
nopaneltrue
For full details on how to create an API Endpoint, see Setting up an API Endpoint.
_email_endpoint
_email_endpoint
nopaneltrue
s are a type of Actionflow that run in response to an incoming email. They include the ability to handle file attachments. 

Insert excerpt
_property_icon
_property_icon
nopaneltrue
 Properties Tab

Parent Details

The name of the container that this item is within or belongs to, if applicable. See Parent Details on Common Properties.

Basic Settings

FieldDescription
NameThe name of the API Email Endpoint.

Actionflow Icon


A custom icon for the API Email Endpoint.

Upload a new icon by clicking the 

Insert excerpt
_add_icon
_add_icon
nopaneltrue
 icon or choose an image already uploaded to the application by clicking 
Insert excerpt
_image_list
_image_list
nameicon
nopaneltrue
.

URL Alias

When set, instead of the URL (below) being constructed using the API Endpoint name and application name, it will use the alias instead.

URL

This field is read only.

Displays the URL for the API that is used to call it.

If URL Alias (above) is populated, this URL will change accordingly and any special characters will be translated, such as, spaces to their URL encoded form (%20).

API Mode

Choose if the API Endpoint should:

  • Wait for result (Synchronous) (Default): The API waits for the results or the timeout to occur. Note: If the timeout occurs the command is aborted.
  • Poll for result (Asynchronous): The API is called and a response is returned immediately including the process ID. Subsequent API calls can be made using the process ID to fetch the status of the action. The asynchronous mode can be thought of as “fire and forget”.

Allow Anonymous Connections

Insert excerpt
Setting up an API EndpointSetting up an API Endpoint
nameAllowAnonymousConnections
nopaneltrue
Timeout

Optional.

Specify a maximum time in milliseconds that the API will wait for.

When set, this value will override the default timeout, which is 60 seconds where API Mode is Synchronous and 500 milliseconds where API Mode is Asynchronous. 

However, if a timeout parameter has been provided in the URL calling this API, that will override both this Timeout value and the default value.

Actions

Displays the actions in the API Endpoint, e.g. Calculate, View
Save Attachments to

The location where email attachments are saved to. If no location is specified, attachments will not be saved.

Create a new

Insert excerpt
_tableFile
_tableFile
nopaneltrue
by clicking the
Insert excerpt
_add_icon
_add_icon
nopaneltrue
 icon or choose an existing table using the
Insert excerpt
_tableFile
_tableFile
nameicon
nopaneltrue
icon or selecting from the drop down list.

Actions

Displays the action nodes in the Email Endpoint, e.g.

Insert excerpt
_action_save
_action_save
nopaneltrue
.

Input Connections

Displays the input connection points coming into the API Email Endpoint, and their Type. See See Understanding Connection Points.Double Double-click a connection point to view and create Input Parameters. See Setting up an API Endpoint.

Output Connections

Displays the output connection points going out of the API Endpoint, and their Type.

Logging Settings

FieldDescriptionLog Requests

Disabled by default. 

When enabled, this creates a message in the System Console containing the HTTP Method (GET, POST, etc.), URL, client, headers and truncated request body.

This is useful for debugging and testing, and should be disabled once testing is completed.

Log Response

Disabled by default. 

When enabled, this creates a message in the System Console containing the status code, status message, response headers and truncated response body.

This is useful for debugging and testing, and should be disabled once testing is completed.

 

Email Endpoints contain a number of preconfigured input parameters, e.g. to, subject, from, bcc, body, etc.

Log File Retention Settings

Insert excerpt
Actionflow Properties
Actionflow Properties
nameLogFileRetentionSettings
nopaneltrue

Advanced

FieldDescription
Prioritise throughput over ordering

Insert excerpt
Actionflow Properties
Actionflow Properties
namePrioritiseThroughputOverOrdering
nopaneltrue

Exclusion Group

This field is case insensitive.

If this field is populated, only one Actionflow/API Endpoint with this Exclusion Group can be running at any one time. Attempting to run a second Actionflowsecond Actionflow/API Endpoint with the same exclusion group will return a warning and the Actionflow will not run. This applies whether the Actionflow is run manually or automatically using a schedule.

Exclusion Group are evaluated before any Actionflow/API Endpoints are started. 

If there is no Actionflowno Actionflow/API Endpoint already running with this exclusion group then the Actionflowthe Actionflow/API Endpoint will continue. The action will be considered to be using this exclusion group from this point until the Actionflowthe Actionflow/API Endpoint has completed.

Description

FieldDescription
DescriptionA short explanation of the API Endpoint's purpose.

Insert excerpt
_security_icon
_security_icon
nopaneltrue
 Security

Insert excerpt
Actionflow Security and Permissions
Actionflow Security and Permissions
nameintro
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

Tip
titlePackages
API Endpoints can be held in and run from a Package.