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 fields	Description
Response	Defines 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 headers	Defines the header used by the response. Only present if defined in the recipe's New API request trigger.
Response body	Defines the schema of the body used by the response. Only present if defined in the recipe's New API request trigger.

Output

Output fields	Description
Context	Metadata about the API request. This field has the following subfields: Output fields Description Calling IP address The IP address of the client calling this recipe as a REST endpoint. Access profile Details about the access profile used to perform the request. API client Contains details about the API client used to perform the request. JWT claims Only available if a JWT token is used. Contains details about the JWT claims used to authenticate the request. Request headers Details about the request headers defined for the endpoint. For each request header defined for the endpoint, a datapill will be created.
Request parameters	Details about the properties defined for the endpoint's Request schema. For each property, a datapill will be created.

Additional Resources

• API Platform
• API recipes
• Create an API recipe
• New API request trigger