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 fieldsDescription
Content typeDefines 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 headerDefines the parameters request headers must have.
Path parametersDefines the parameters to accept in the endpoint path for JSON and Text/XML requests.
Query parametersDefines the parameters to accept in the endpoint's query string for JSON and Text/XML requests.
Request structureDefines 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 bodyOnly 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 schemaLegacy 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 fieldsDescription
Content typeDefines the data format of the response. Defaults to JSON if left blank.
Response headerDefines the parameters response headers will have.
ResponsesDefines the possible responses to a request sent to the endpoint.

This field has the following subfields:

Input fieldsDescription
NameThe name of the response. For example: Unauthorized or Created
CodeThe HTTP status code to be associated with the response which identifies the type of response. For example: Unauthorized responses are associated with 401 status codes.
Response structureDefines the outermost structure of the response 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.
Response schemaOnly appears when Response structure is set to Object or Array of objects. Defines the expected schema response bodies will have.

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 fieldsDescription
ContextMetadata about the API request.

This field has the following subfields:

Output fieldsDescription
Calling job IDThe ID of the job associated with the request.
Calling recipe IDIf called from a recipe, the ID of the recipe that sent the request.
Calling IP addressThe IP address of the client calling this recipe as an endpoint.
Access profileDetails about the access profile used to perform the request.
API clientContains details about the API client used to perform the request.
JWT claimsOnly available if a JWT token is used. Contains details about the JWT claims used to authenticate the request.
RequestContains details about the request's content type and body.

This field has the following subfields:

Output fieldsDescription
Content typeApplicable only if the request's Content type is Raw. The Content-Type header value from the request.
Request body (raw)Applicable only if the request's Content type is Raw. The full, raw body of the request.
Request body (JSON)Applicable only if the request's Content type is JSON. A JSON object containing all the fields defined in the Request body field or the legacy Request schema field.
Request bodyContains 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 parametersLegacy 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: