workato-recipes

Workato Recipes Base Skill - Agent Instructions

This document provides foundational knowledge for AI agents to generate valid Workato recipe JSON. This is the base skill that connector-specific skills (stripe-recipes, salesforce-recipes, etc.) extend.

CRITICAL: Pre-Generation Checklist

For EXISTING projects (recipes already exist):

1. Read 1-2 existing .recipe.json files to understand project structure and patterns
2. Verify connection names - ask user for exact connection names in their workspace
3. Follow established folder structure - match where recipes and connections are organized

For GREENFIELD projects (no existing recipes):

1. Use skill templates as reference - see templates/ directory in each skill
2. Use standard file naming - {recipe_name}.recipe.json (lowercase, underscores for spaces)
3. Start recipe names with action verbs - "Create...", "Search...", "Update...", "Process..."
4. Ask user for connection names - exact names from their Workato workspace

ALWAYS (both scenarios):

1. Use descriptive UUIDs - {action}-{number} format (e.g., search-contact-001, return-success-005)
2. Use API endpoint triggers for testability (unless callable recipe is specifically needed)
3. Define all response codes upfront in the trigger (200, 400, 500 at minimum)

UUID Format (MANDATORY)

ALWAYS use descriptive UUIDs, regardless of what existing recipes in a project use:

search-contact-001
create-customer-002
if-found-003
return-success-004
return-error-005

NEVER use random hex UUIDs:

a1b2c3d4-e5f6-7890-abcd-ef1234567890  ← ANTI-PATTERN
11111111-1111-1111-1111-111111111111  ← ANTI-PATTERN

NOTE: Recipes created in Workato's declarative UI have random hash UUIDs. This is a platform limitation, NOT a pattern to follow. When you see random UUIDs in existing recipes, do NOT copy them. Always use descriptive UUIDs for new recipes and actions.

Recipe JSON Structure (CRITICAL)