Zapier · JSON Structure

Partner Api Zap Step Structure

One step in a Zap

Type: object Properties: 3 Required: 3
IntegrationsiPaaS

ZapStep is a JSON Structure definition published by Zapier, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type_of app params

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/zapier/refs/heads/main/json-structure/partner-api-zap-step-structure.json",
  "name": "ZapStep",
  "description": "One step in a Zap",
  "type": "object",
  "properties": {
    "type_of": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TypeOfEnum"
        }
      ],
      "description": "The type of this Step\n\n* `read` - read\n* `write` - write\n* `filter` - filter\n* `search` - search\n* `search_or_write` - search_or_write",
      "example": "standard"
    },
    "app": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ZapStepApp"
        }
      ],
      "description": "The App used in this Step",
      "example": "example-value"
    },
    "params": {
      "type": "object",
      "additionalProperties": {},
      "readOnly": true,
      "description": "The parameters used by this Step",
      "example": {}
    }
  },
  "required": [
    "app",
    "params",
    "type_of"
  ]
}