Send to URL | SEND_TO_URL
Sends data to a internet URL and waits for a response from the remote server.
Properties
Send to Endpoint ${}
url
The URL that the outbound request will be sent to.
Method
method
The HTTP header method used in the outbound request
| valid options | |
|---|---|
| GET | Commonly used when retrieving information. |
| POST | Commonly used when sending data to the server. |
| PUT | Commonly used to completely replace an existing record. |
| PATCH | Commonly used to partially replace an existing record. |
| DELETE | Commonly used to delete an existing record. |
| COPY | Commonly used to create duplicate of an existing record |
| HEAD | Similar to a GET request, but the response only contains a header. |
| OPTIONS | Commonly used when describing the communication options of the endpoint. |
| LINK | Commonly used to establish a data reference between records. |
| UNLINK | Commonly used to remove a data reference between records. |
| PURGE | Commonly used to delete cached resources. |
| LOCK | Commonly used to restrict access to a specified record. |
| UNLOCK | Commonly used unrestrict access to a specified record. |
| PROPFIND | Commonly used when retrieving properties from a web resource. |
| VIEW | |
Send Format
format
The outbound request record's content type which is to inform the remote service what type of data is being sent.
| valid options | |
|---|---|
| None | No content type header will be set |
| Form Submission application/x-www-form-urlencoded | For sending simple form submission data |
| JSON application/json | Data will be sent using JSON formatting. |
| Plain Text text/plain | Text data will be sent as is with no formatting. |
| XML text/xml | Data will be sent formatted as an XML document. |
| HTML text/html | Data will be sent formatted as an HTML document. |
| CSV text/csv | Data will be sent as a comma delimited flat file. |
Response Format
bodyFormat
Specifies to the remote service how their response is formatted.
| valid options | |
|---|---|
| JSON application/json | JSON (Javascript Object Notation). Common format for communication between computer systems. |
| Plain Text text/plain | The raw unparsed data in a text document |
| XML text/xml | Uses XML syntax and structure. Common format for communication between computer systems. |
| HTML text/html | Response is in HTML and is designed to be interpreted by a person viewing the results in a webpage |
| CSV text/csv | Comma delimited flat file. Use this when importing the data into spreadsheet software. |
Authorization
authType
The authentication protocol used to access the remote service.
| valid options | |
|---|---|
| None | No formal authentication protocol will be used. |
| Basic Auth Basic | Will use traditional basic authentication. |
| OAuth 1.0 OAuth | Will use Oauth 1.0 authentication. Oftened used for intra-network communications. |
| Instalink API/Consumer Token InstalinkToken | Will use Instalink's built-in authentication method. Useful for authenticating calls between various Instalink hosted endpoints. |
| Amazon Signature Version 4 AmazonV4 | DEPRECATED: Amazon Signature Version 4 authentication. Used when accessing AWS services. |
Username ${}
authBasicUsername
The username that is used for basic authentication
Password ${}
authBasicPassword
The password that is used for basic authentication
Consumer Key ${}
authOauth1ConsumerKey
The consumer key that the remote service has provided to use when accessing their service.
Consumer Secret ${}
authOauth1ConsumerSecret
The consumer secret that the remote service has provided to use when accessing their service.
Token ${}
authOauth1TokenKey
The token key that the remote service has provided to use when accessing their service.
Token Secret ${}
authOauth1TokenSecret
The token secret that the remote service has provided to use when accessing their service.
Signature Method
authOauth1SignatureMethod
The hashing algorithm to use to package the authentication request. Consult your remote service provider for information about which signature method(s) they accept.
Realm (optional) ${}
authOauth1Realm
Optional field. The value of this property may differ depending on how your remote service provider implements Oauth 1.0. Some remote services require this property to be set. Please consult your remote service provider for more information about this property.
Token Value ${}
authInstalinkToken
The Instalink provisioned token that has been provisioned access to the remote resource.
Template ${}
template
The template used to format the data that is to be sent to the remote resource. Accepts template syntax.
Use Template
useTemplate
When enabled the outbound request data will use the provided template instead of preformatted field values.
Record Identifier Template ${}
recordIdentifierTemplate
Label that helps to identify outbound call records in the admin panel. Please set this to make your logs easier to navigate and search. Accepts template syntax.
Use Namespace for Output
useNamespace
When enabled, all data recieved from the outbound request will be assigned to the key as defined in sendurl_namespace. By default the data is added to the root process data and is accessible by whatever keys may be provided in the request response. You should enable this if the request response is not expected to be an object with keys.
Output Namespace
namespace
The key that will contain the data of the outbound request response.
CSV Header Expected
csvHasHeader
When enabled and the body of the response from the server is a CSV document, the first row of the data is used to determine the keys for all subsequent records and the records will be returned as maps with these keys. When not enabled, the first row of the CSV data is not treated specially and all rows are returned as lists.
Send Data In Body
sendDataInBody
Force the provided data to be sent in the body instead of the query string in a GET or HEAD HTTP request.
Set Request Timeout
doTimeout
When enabled the outbound request will fail after a specified time if no response has been returned from the remote server.
Timeout Seconds
timeout
When a timeout is enabled, sets the number of seconds for the timeout.
Enable GZIP Response
gzip
When enabled, the outbound call will accept and transparently inflate a response from the remote server in a gzip encoding.
Fields
fields
A set of records that are used to define process data keys that are to be included when executing various actions.
Field Key
fields[].key
Where to find or set the data in the process data. Uses dot notation conventions.
Value ${}
fields[].value
The value to set in the process data. Accepts template syntax.