Zapier · JSON Structure

Partner Api Zap Structure

User Zaps.

Type: object Properties: 6 Required: 6
IntegrationsiPaaS

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

Properties

id title state steps url modified_at

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-structure.json",
  "name": "Zap",
  "description": "User Zaps.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "The numeric identifier of this Zap",
      "example": 100
    },
    "title": {
      "type": "string",
      "description": "The title of this Zap",
      "example": "Example Name"
    },
    "state": {
      "type": "string",
      "description": "The current state of this Zap",
      "example": "active"
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ZapStep"
      },
      "readOnly": true,
      "description": "The steps this Zap consists of",
      "example": [
        {}
      ]
    },
    "url": {
      "type": "uri",
      "readOnly": true,
      "description": "The URL to this Zap",
      "example": "https://example.com/path/abc123"
    },
    "modified_at": {
      "type": "string",
      "description": "The last time this Zap was modified",
      "example": "example-value"
    }
  },
  "required": [
    "id",
    "modified_at",
    "state",
    "steps",
    "title",
    "url"
  ]
}