{"id":49826,"library":"zapier-platform-schema","title":"Zapier Platform Schema","description":"Schema definition for CLI apps in the Zapier Developer Platform, providing JSON Schema-based validation for integration configuration, triggers, actions, searches, and authentication schemes. Current stable version is 19.0.0. Releases follow the platform CLI updates. Differentiates by being the official schema used by Zapier's platform CLI tooling, with rigorous versioning and exported schema artifacts.","status":"active","version":"19.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/zapier/zapier-platform","tags":["javascript"],"install":[{"cmd":"npm install zapier-platform-schema","lang":"bash","label":"npm"},{"cmd":"yarn add zapier-platform-schema","lang":"bash","label":"yarn"},{"cmd":"pnpm add zapier-platform-schema","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"Package exports a default object representing the full schema. CJS require works but TypeScript may prefer default import.","wrong":"const schema = require('zapier-platform-schema')","symbol":"default","correct":"import schema from 'zapier-platform-schema'"},{"note":"Named export available since earlier versions. TypeScript definitions included.","wrong":"const { AppSchema } = require('zapier-platform-schema')","symbol":"AppSchema","correct":"import { AppSchema } from 'zapier-platform-schema'"},{"note":"Named export, not default. Ensure correct destructuring.","wrong":"import FieldSchema from 'zapier-platform-schema'","symbol":"FieldSchema","correct":"import { FieldSchema } from 'zapier-platform-schema'"},{"note":"Named export providing type constants.","wrong":null,"symbol":"types","correct":"import { types } from 'zapier-platform-schema'"}],"quickstart":{"code":"import schema from 'zapier-platform-schema'\n\nconst appDefinition = {\n  title: 'My App',\n  version: '1.0.0',\n  platformVersion: '19.0.0',\n}\n\nconst validator = schema.validate(appDefinition)\nconsole.log(validator.valid ? 'Valid!' : 'Invalid:', validator.errors)\n","lang":"typescript","description":"Demonstrates importing the default schema and using it to validate an app definition object."},"warnings":[{"fix":"Remove usage of 'withoutPrefix' from field definitions.","message":"Removed deprecated 'withoutPrefix' option from all schema fields.","severity":"breaking","affected_versions":">=18.0.0"},{"fix":"Ensure both packages are installed and compatible.","message":"The 'zapier-platform-core' package formerly depended on 'zapier-platform-schema' directly; now it's a peer dependency.","severity":"deprecated","affected_versions":">=15.0.0"},{"fix":"Refer to JSON Schema Draft 07 specification; avoid draft-04 or earlier keywords.","message":"Schema validation uses JSON Schema Draft 07; unsupported keywords may cause silent failures.","severity":"gotcha","affected_versions":">=0.0.0"}],"env_vars":null,"search_vec":"'19.0.0':33 'action':24 'app':8 'artifact':59 'authent':27 'base':18 'cli':7,38,51 'configur':22 'current':29 'definit':5 'develop':12 'differenti':40 'export':57 'follow':35 'integr':21 'javascript':60 'json':15 'offici':44 'platform':2,13,37,50 'provid':14 'releas':34 'rigor':54 'schema':3,4,17,45,58 'schema-bas':16 'scheme':28 'search':25 'stabl':30 'tool':52 'trigger':23 'updat':39 'use':46 'valid':19 'version':31,55 'zapier':1,11,48","created_at":"2026-06-07T17:03:48.452244+00:00","updated_at":"2026-06-07T17:03:48.452244+00:00","problems":[{"fix":"Run `npm install zapier-platform-schema` or `yarn add zapier-platform-schema`.","cause":"Package not installed or not in node_modules.","error":"Error: Cannot find module 'zapier-platform-schema'"},{"fix":"Ensure default import: `import schema from 'zapier-platform-schema'`.","cause":"Using default import incorrectly (e.g., importing named export instead of default).","error":"TypeError: schema.validate is not a function"},{"fix":"Ensure fields property is an array of field objects.","cause":"Provided a string or object instead of array for fields in a trigger/action.","error":"ValidationError: 'fields' must be an array"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://platform.zapier.com/","github":"https://github.com/zapier/zapier-platform","docs":null,"changelog":null,"pypi":null,"npm":"zapier-platform-schema","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}