API platform by Workato - New API request trigger
The New API request trigger defines the request and response structure for a recipe endpoint and creates a job when it receives an API request.
ACCESS REQUIREMENTS
API recipes require access to the API Platform feature. Contact your Customer Success Manager if you don't have access to the Platform > API platform page in Workato.
Input
Input fields in the Request section define the structure of API requests to the endpoint:
| Input fields | Description |
|---|---|
| Content type | Defines the data format of the request. Choose application/json, text/plain or multipart/form-data. Use multipart/form-data to upload large attachments (up to 5GB). |
| Request header | Defines the parameters request headers must have. |
| Path parameters | Defines the parameters to accept in the endpoint path for JSON and Text/XML requests. |
| Query parameters | Defines the parameters to accept in the endpoint's query string for JSON and Text/XML requests. |
| Request structure | Defines the outermost structure of the request body: a single Object, or a top-level array, such as an Array of objects, Array of strings, Array of integers, Array of numbers, Array of booleans, Array of dates, or Array of date-times. Defaults to Object. |
| Request body | Only appears when Request structure is set to Object or Array of objects, and when the legacy Request schema is empty. Defines the expected schema request bodies must have. Datapills for these fields appear in the Request body group. |
| Request schema | Legacy field that remains fully supported. Appears in recipes that defined a request schema before the Request body field was available. Defines the expected schema request bodies must have. Datapills for these fields appear in the Request parameters group and show as deprecated. Clear this field to define the Request body field instead. |
Input fields in the Response section define the structure of responses the endpoint sends:
| Input fields | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Content type | Defines the data format of the response. Defaults to JSON if left blank. | ||||||||||
| Response header | Defines the parameters response headers will have. | ||||||||||
| Responses | Defines the possible responses to a request sent to the endpoint. This field has the following subfields:
|
PROCESSING BINARY CONTENT
Multipart data may contain binary data, including images and pdf files. You must ensure that these files are in utf-8 encoding format. Workato recipe string processing supports utf-8.
Output
| Output fields | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Context | Metadata about the API request. This field has the following subfields:
| ||||||||||||||
| Request | Contains details about the request's content type and body. This field has the following subfields:
| ||||||||||||||
| Request body | Contains a datapill for each field defined in the Request body field. This group represents the list of items in the request body when Request structure is set to an array type. | ||||||||||||||
| Request parameters | Legacy group. Contains a datapill for each field defined in the legacy Request schema. When Request structure is set to an array type, this group also includes List size and List index datapills for use inside a loop over the request body's items. |
Additional Resources
Last updated: