LISTEN
Creates a new endpoint on your service that listens for incoming http requests. Use at the start of a data flow with the IF operator.
Properties
Method
listen_method
The http request method for which the listening endpoint will accept requests.
| 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 | |
Primary Authentication
listen_auth
The reference to the authentication protocol used to restrict access to the listener to only those who provide the required credentials. Add authorization records to your project. Please see Project Authorizations for more info.
Endpoint URL Path
listen_customPath
The url path where your endpoint is listening on your Instalink account.
Accept Files
listen_acceptFiles
When enabled, the endpoint will accept file uploads.
Record Identifier Template
listen_recordIdentifierTemplate
A searchable index of your incoming requests to the endpoint. This is important to set to make it easier to read your service logs. Accepts the templating syntax.
Use Namespace for Input
listen_useNamespace
When enabled, all data sent to the listener will be assigned to the key as defined in listen_namespace. By default the data is added to the root process data and is accessible by whatever keys may be provided in the request body. You should enable this if the request body is not expected to be an object with keys.
Input Namespace
listen_namespace
The key that will contain the data of the inbound request body.
Count Items Path
listen_countRecordsPath
Collect Index Keys Path
listen_indexKeysPath
Enable CORS
listen_enableCors
CORS Allow Origin
listen_corsAllowOrigin
CORS Allow Methods
listen_corsAllowMethods
CORS Allow Headers
listen_corsAllowHeaders
CORS Expose Headers
listen_corsExposeHeaders
CORS Max Age Seconds
listen_corsMaxAge
CORS Allow Credentials
listen_corsAllowCredentials
listen_UrlKey
Random guid generated by the system used to help identify requests in system logs
listen_customPathUnique
An index that ensures that every path is unique on your account. Automatically set.
Additional Authentications
authorizations
A reference to the project authorization records that are available to LISTEN and RESPONSE actions in order to create permissioned requests.
Accepted Files
acceptedFiles
A set of records that define the parameters of what file uploads a LISTEN action will allow.
observers
A set of records that define mechanisms for inspecting success and error log occurrences as they occur.
formFields
A set of records that define input fields for Instalink forms within the admin panel.