# API Recipes - Response To API Request Action

This action allows you to define how an endpoint in an API recipe responds to specific actions in the recipe.

When using this action, note that:

  • This action ends recipe jobs. When a job successfully executes this action, the current job will end. Any steps after this action will be ignored.
  • Action data is returned in the form of an HTTP response.

# Requirements

To use this action, you need:

  • Access to the API Platform feature. If you don't see this option in the Tools menu, reach out to your Customer Success Manager.

# Input

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

Field 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

Field Description
Context Metadata about the API request.

This field also has some additional sub-fields:

Field 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