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

API platform by Workato - Respond to API request action ​

The Respond to API request action ends the current job and sends an HTTP response defined by the New API request trigger.

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 ​

The fields for this action define how the endpoint responds to API requests:

Input fieldsDescription
ResponseDefines the type of the response. The options in this menu are determined by the responses defined in the recipe's New API request trigger.
Response headersDefines the header used by the response. Only present if defined in the recipe's New API request trigger.
Response bodyDefines the schema of the body used by the response. Only present if defined in the recipe's New API request trigger.

Output ​

Output fieldsDescription
ContextMetadata about the API request.

This field has the following subfields:

Output fieldsDescription
Calling IP addressThe IP address of the client calling this recipe as a REST 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.
Request headersDetails about the request headers defined for the endpoint. For each request header defined for the endpoint, a datapill will be created.
Request parametersDetails about the properties defined for the endpoint's Request schema. For each property, a datapill will be created.

Additional Resources ​

Last updated: