API recipe endpoints

API recipes are a type of recipe that you can call as API endpoints. You can use these endpoints in other recipes or share the endpoints with external users. For example, you can create an API endpoint that provides inventory status to your suppliers.

CALLABLE RECIPES

API recipes replace the API endpoint functionality of Callable recipes. Refer to the FAQ for more information.

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.

API recipes

API recipes define recipe logic, request schemas, and response schemas for the API. Refer to the Create an API recipe guide to configure an API recipe.

API recipe

Triggers and actions

The API platform by Workato connector contains the following resources:

• The New API request trigger defines a request and response structure and creates a job when it receives an API request.
• The Response to API request action ends the current job and sends one of the responses defined by the trigger.

API recipes require both steps to complete successfully. Workato automatically creates a recipe with the New API request trigger when you select Build an API endpoint as a recipe's starting point.

Recipe endpoints

Recipe endpoints define the HTTP method, endpoint name, endpoint path, request timeout, schema validation, and cache response for the API. Refer to the Configure a new API recipe endpoint guide to configure a recipe endpoint.

Recipe endpoint

API collections

API collections group API recipe endpoints to streamline access control for users and applications. Refer to the API collections guide to configure an API collection.

Endpoints in an API collection

API performance

You can improve API performance using the following methods:

• Disable logs: Go to a recipe's Settings > Data retention tab and configure the Jobs data retention setting to disable log creation. Refer to the Defining data retention for recipes guide for more information.

• Enable API caching: Go to an endpoint's Settings tab and enable Cache response to enable API caching. Refer to the API endpoint caching guide for more information.