Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
API platform
API endpoints
API recipe endpoints

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.
Request schemaDefines the expected schema request bodies must have.

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.
SchemaDefines 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 schema.

Additional Resources ​

Last updated: