Workato · JSON Structure

Workato Developer Api Recipe Structure

A Workato recipe representing an automated workflow.

Type: object Properties: 11
AgenticAPI ManagementAutomationB2BEmbedded iPaaSEnterpriseIntegrationiPaaSOrchestrationWorkflow

Recipe is a JSON Structure definition published by Workato, describing 11 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description folder_id running trigger_application action_applications created_at updated_at stopped_at stop_cause

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workato/refs/heads/main/json-structure/workato-developer-api-recipe-structure.json",
  "name": "Recipe",
  "description": "A Workato recipe representing an automated workflow.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Unique identifier of the recipe."
    },
    "name": {
      "type": "string",
      "description": "Display name of the recipe."
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of what the recipe does."
    },
    "folder_id": {
      "type": "int32",
      "description": "ID of the folder containing this recipe."
    },
    "running": {
      "type": "boolean",
      "description": "Whether the recipe is currently active and processing events."
    },
    "trigger_application": {
      "type": "string",
      "description": "The connector used for the recipe's trigger."
    },
    "action_applications": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of connectors used in the recipe's actions."
    },
    "created_at": {
      "type": "datetime",
      "description": "Timestamp when the recipe was created."
    },
    "updated_at": {
      "type": "datetime",
      "description": "Timestamp when the recipe was last updated."
    },
    "stopped_at": {
      "type": "datetime",
      "description": "Timestamp when the recipe was last stopped."
    },
    "stop_cause": {
      "type": "string",
      "description": "Reason the recipe was stopped, if applicable."
    }
  }
}