This is automatically generated by the npm run docs command in zapier-platform-schema version 16.3.1.

• /AppFlagsSchema
• /AppSchema
• /AuthenticationBasicConfigSchema
• /AuthenticationCustomConfigSchema
• /AuthenticationDigestConfigSchema
• /AuthenticationOAuth1ConfigSchema
• /AuthenticationOAuth2ConfigSchema
• /AuthenticationSchema
• /AuthenticationSessionConfigSchema
• /BasicActionOperationSchema
• /BasicCreateActionOperationSchema
• /BasicDisplaySchema
• /BasicHookOperationSchema
• /BasicOperationSchema
• /BasicPollingOperationSchema
• /BufferConfigSchema
• /BulkReadSchema
• /BulkReadsSchema
• /CreateSchema
• /CreatesSchema
• /DynamicFieldsSchema
• /FieldChoiceWithLabelSchema
• /FieldChoicesSchema
• /FieldMetaSchema
• /FieldOrFunctionSchema
• /FieldSchema
• /FieldsSchema
• /FlatObjectSchema
• /FunctionRequireSchema
• /FunctionSchema
• /FunctionSourceSchema
• /HydratorsSchema
• /KeySchema
• /LockObjectSchema
• /MiddlewaresSchema
• /RedirectRequestSchema
• /RefResourceSchema
• /RequestSchema
• /ResourceMethodCreateSchema
• /ResourceMethodGetSchema
• /ResourceMethodHookSchema
• /ResourceMethodListSchema
• /ResourceMethodSearchSchema
• /ResourceSchema
• /ResourcesSchema
• /ResultsSchema
• /SearchAndCreatesSchema
• /SearchOrCreateSchema
• /SearchOrCreatesSchema
• /SearchSchema
• /SearchesSchema
• /ThrottleObjectSchema
• /ThrottleOverrideObjectSchema
• /TriggerSchema
• /TriggersSchema
• /VersionSchema

Codifies high-level options for your integration.

• Type - object
• Source Code

• { skipHttpPatch: true, skipThrowForStatus: false }
• { skipHttpPatch: false, skipThrowForStatus: true }
• {}

• { foo: true } - Invalid key.
• { skipHttpPatch: 'yes' } - Invalid value.
• { skipThrowForStatus: 'no' } - Invalid value.

Represents a full app.

• Type - object
• Source Code

• { version: '1.0.0', platformVersion: '10.1.2' }

• { version: 'v1.0.0', platformVersion: '10.1.2' } - Invalid value for version.
• { version: '1.0.0', platformVersion: 'v10.1.2' } - Invalid value for platformVersion.

Config for Basic Authentication. No extra properties are required to setup Basic Auth, so you can leave this empty if your app uses Basic Auth.

• Type - object
• Source Code

• {}

• { foo: true } - Invalid key.

Config for custom authentication (like API keys). No extra properties are required to setup this auth type, so you can leave this empty if your app uses a custom auth method.

• Type - object
• Source Code

• {}

• {
    sendCode: {
      url: 'https://example.com/api/send',
      headers: { Authorization: 'Bearer {{process.env.API_KEY}}' },
      body: {
        to_phone_number: '{{bundle.inputData.phone_number}}',
        code: '{{bundle.inputData.code}}'
      }
    }
  }
  

• { foo: true } - Invalid key.

Config for Digest Authentication. No extra properties are required to setup Digest Auth, so you can leave this empty if your app uses Digets Auth.

• Type - object
• Source Code

• {}

• { foo: true } - Invalid key.

Config for OAuth1 authentication.

• Type - object
• Source Code

• {
    getRequestToken: { require: 'some/path/to/file.js' },
    authorizeUrl: { require: 'some/path/to/file2.js' },
    getAccessToken: { require: 'some/path/to/file3.js' }
  }
  

• {
    getRequestToken: { require: 'some/path/to/file.js' },
    authorizeUrl: { require: 'some/path/to/file2.js' }
  }
  
  Missing required key.

Config for OAuth2 authentication.

• Type - object
• Source Code

• {
    authorizeUrl: { require: 'some/path/to/file.js' },
    getAccessToken: { require: 'some/path/to/file2.js' }
  }
  

• {
    authorizeUrl: { require: 'some/path/to/file.js' },
    getAccessToken: { require: 'some/path/to/file2.js' },
    refreshAccessToken: { require: 'some/path/to/file3.js' },
    codeParam: 'unique_code',
    scope: 'read/write',
    autoRefresh: true,
    enablePkce: true
  }
  

• { authorizeUrl: { require: 'some/path/to/file.js' } } - Missing required key getAccessToken.

Represents authentication schemes.

• Type - object
• Source Code

• { type: 'basic', test: '$func$2$f$' }
• { type: 'custom', test: '$func$2$f$', fields: [ { key: 'abc' } ] }
• { type: 'custom', test: '$func$2$f$', connectionLabel: '{{bundle.inputData.abc}}' }
• { type: 'custom', test: '$func$2$f$', connectionLabel: '$func$2$f$' }
• { type: 'custom', test: '$func$2$f$', connectionLabel: { url: 'abc' } }

• {} - Missing required keys: type and test
• '$func$2$f$' - Must be object
• { type: 'unknown', test: '$func$2$f$' } - Invalid value for key: type
• { type: 'custom', test: '$func$2$f$', fields: '$func$2$f$' } - Invalid value for key: fields

Config for session authentication.

• Type - object
• Source Code

• { perform: { require: 'some/path/to/file.js' } }

• {} - Missing required key: perform

Represents the fundamental mechanics of a search/create.

• Type - object
• Source Code

• { perform: { require: 'some/path/to/file.js' }, sample: { id: 42, name: 'Hooli' } }

• { perform: { require: 'some/path/to/file.js' } } - Missing required key: sample. Note - This is only invalid if display is not explicitly set to true and if it does not belong to a resource that has a sample.

Represents the fundamental mechanics of a create.

• Type - object
• Source Code

• { perform: { require: 'some/path/to/file.js' }, sample: { id: 42, name: 'Hooli' } }

• { perform: { require: 'some/path/to/file.js' } } - Missing required key: sample. Note - This is only invalid if display is not explicitly set to true and if it does not belong to a resource that has a sample.

Represents user information for a trigger, search, or create.

• Type - object
• Source Code

• { hidden: true }
• { label: 'New Thing', description: 'Gets a new thing for you.' }

• {
    label: 'New Thing',
    description: 'Gets a new thing for you.',
    directions: 'This is how you use the thing.',
    hidden: false
  }
  

• { label: 'New Thing', hidden: false } - Missing required key: description
• { description: 'Gets a new thing for you.', hidden: false } - Missing required key: label

Represents the inbound mechanics of hooks with optional subscribe/unsubscribe. Defers to list for fields.

• Type - object
• Source Code

• {
    type: 'hook',
    perform: { require: 'some/path/to/file.js' },
    performList: { require: 'some/path/to/file2.js' },
    performSubscribe: { require: 'some/path/to/file3.js' },
    performUnsubscribe: { require: 'some/path/to/file4.js' },
    sample: { id: 42, name: 'Hooli' }
  }
  

• {
    type: 'hook',
    perform: { require: 'some/path/to/file.js' },
    performList: { require: 'some/path/to/file2.js' },
    performSubscribe: { require: 'some/path/to/file3.js' },
    performUnsubscribe: { require: 'some/path/to/file4.js' }
  }
  
  Missing required key: sample. Note - This is only invalid if display is not explicitly set to true and if it does not belong to a resource that has a sample.

Represents the fundamental mechanics of triggers, searches, or creates.

• Type - object
• Source Code

• { perform: { require: 'some/path/to/file.js' }, sample: { id: 42, name: 'Hooli' } }

• { perform: { require: 'some/path/to/file.js' } } - Missing required key: sample. Note - This is only invalid if display is not explicitly set to true and if it does not belong to a resource that has a sample.

Represents the fundamental mechanics of a trigger.

• Type - object
• Source Code

• { perform: { require: 'some/path/to/file.js' }, sample: { id: 42, name: 'Hooli' } }

• { perform: { require: 'some/path/to/file.js' } } - Missing required key: sample. Note - This is only invalid if display is not explicitly set to true and if it does not belong to a resource that has a sample.

Currently an internal-only feature. Zapier uses this configuration for creating objects in bulk.

• Type - object
• Source Code

• { groupedBy: [ 'workspace', 'sheet' ], limit: 100 }

• { groupedBy: [], limit: 100 } - Empty groupedBy list provided: [].
• { groupedBy: [ 'workspace' ] } - Missing required key: limit.
• { limit: 1 } - Missing required key: groupedBy.

How will Zapier fetch resources from your application?

• Type - object
• Source Code

• {
    key: 'recipes',
    noun: 'Recipes',
    display: { label: 'Recipes', description: 'A Read that lets Zapier fetch all recipes.' },
    operation: {
      perform: '$func$0$f$',
      sample: { id: 1, firstName: 'Walter', lastName: 'Sobchak', occupation: 'Bowler' }
    }
  }
  

• {
    display: { label: 'Get User', description: 'Retrieve a user.' },
    operation: { description: 'Define how this search method will work.' }
  }
  
  Missing required keys: key and noun

Enumerates the bulk reads your app exposes.

• Type - object
• Source Code

• {
    recipes: {
      key: 'recipes',
      noun: 'Recipes',
      display: { label: 'Recipes', description: 'A Read that lets Zapier fetch all recipes.' },
      operation: {
        perform: '$func$0$f$',
        sample: { id: 1, firstName: 'Walter', lastName: 'Sobchak', occupation: 'Bowler' }
      }
    }
  }
  

• {
    readRecipes: {
      key: 'recipes',
      noun: 'Recipes',
      display: { label: 'Recipes', description: 'A Read that lets Zapier fetch all recipes.' },
      operation: {
        perform: '$func$0$f$',
        sample: { id: 1, firstName: 'Walter', lastName: 'Sobchak', occupation: 'Bowler' }
      }
    }
  }
  
  Key must match the key of the associated BulkReadSchema

How will Zapier create a new object?

• Type - object
• Source Code

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
    operation: { perform: '$func$2$f$', sample: { id: 1 } }
  }
  

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
    operation: { perform: '$func$2$f$', sample: { id: 1 }, shouldLock: true }
  }
  

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Create Recipe', description: 'Creates a new recipe.', hidden: true },
    operation: { perform: '$func$2$f$' }
  }
  

• 'abc' - Must be an object

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
    operation: { perform: '$func$2$f$', shouldLock: 'yes' }
  }
  
  Invalid value for key on operation: shouldLock

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
    operation: { perform: '$func$2$f$' }
  }
  
  Missing required key on operation: sample. Note - this is valid if the resource has defined a sample.

Enumerates the creates your app has available for users.

• Type - object
• Source Code

• {
    createRecipe: {
      key: 'createRecipe',
      noun: 'Recipe',
      display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
      operation: { perform: '$func$2$f$', sample: { id: 1 } }
    }
  }
  

• {
    Create_Recipe_01: {
      key: 'Create_Recipe_01',
      noun: 'Recipe',
      display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
      operation: { perform: '$func$2$f$', sample: { id: 1 } }
    }
  }
  

• {
    '01_Create_Recipe': {
      key: '01_Create_Recipe',
      noun: 'Recipe',
      display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
      operation: { perform: '$func$2$f$', sample: { id: 1 } }
    }
  }
  
  Key must start with a letter

• {
    Create_Recipe: {
      key: 'createRecipe',
      noun: 'Recipe',
      display: { label: 'Create Recipe', description: 'Creates a new recipe.' },
      operation: { perform: '$func$2$f$', sample: { id: 1 } }
    }
  }
  
  Key must match the key field in CreateSchema

Like /FieldsSchema but you can provide functions to create dynamic or custom fields.

• Type - /FieldOrFunctionSchema
• Source Code

• []
• [ { key: 'abc' } ]
• [ { key: 'abc' }, '$func$2$f$' ]
• [ '$func$2$f$', '$func$2$f$' ]

• [ {} ] - FieldSchema missing required key: key
• [ { key: 'abc', choices: {} } ] - Invalid value for key in FieldSchema: choices (cannot be empty)
• '$func$2$f$' - Must be an array

An object describing a labeled choice in a static dropdown. Useful if the value a user picks isn't exactly what the zap uses. For instance, when they click on a nickname, but the zap uses the user's full name (image).

• Type - object
• Source Code

• { label: 'Red', sample: '#f00', value: '#f00' }

• { label: 'Red', value: '#f00' } - Missing required key: sample

A static dropdown of options. Which you use depends on your order and label requirements:

• Type - oneOf(object, array[oneOf(string, /FieldChoiceWithLabelSchema)])
• Source Code

• { a: '1', b: '2', c: '3' }
• [ 'first', 'second', 'third' ]

• [ 1, 2, 3 ] - If an array, must be of either type string or FieldChoiceWithLabelSchema
• [ { a: '1', b: '2', c: '3' } ] - If an array, must be of either type string or FieldChoiceWithLabelSchema

Allows for additional metadata to be stored on the field.

• Type - object
• Source Code

• { shouldCapitalize: true }
• { shouldCapitalize: true, internalType: 'datetime' }

• { databank: { primaryContact: 'abc' } } - No complex values allowed
• { needsProcessing: null } - No null values allowed

Represents an array of fields or functions.

• Type - array[oneOf(/FieldSchema, /FunctionSchema)]
• Source Code

• []
• [ { key: 'abc' } ]
• [ { key: 'abc' }, '$func$2$f$' ]
• [ '$func$2$f$', '$func$2$f$' ]

• [ {} ] - Array item not a valid FieldSchema or FunctionSchema
• [ { key: 'abc', choices: {} } ] - Array item not a valid FieldSchema
• '$func$2$f$' - Must be an array

Defines a field an app either needs as input, or gives as output. In addition to the requirements below, the following keys are mutually exclusive:

• children & list
• children & dict
• children & type
• children & placeholder
• children & helpText
• children & default
• dict & list
• dynamic & dict
• dynamic & choices

• Type - object
• Source Code

• { key: 'abc' }
• { key: 'abc', choices: { mobile: 'Mobile Phone' } }
• { key: 'abc', choices: [ 'first', 'second', 'third' ] }
• { key: 'abc', choices: [ { label: 'Red', sample: '#f00', value: '#f00' } ] }
• { key: 'abc', children: [ { key: 'abc' } ] }
• { key: 'abc', type: 'integer', helpText: 'neat' }

• {
    key: 'abc',
    type: 'integer',
    meta: { internalType: 'numeric', should_call_api: true, display_order: 1 }
  }
  

• {} - Missing required key: key
• { key: 'abc', type: 'loltype' } - Invalid value for key: type
• { key: 'abc', choices: {} } - Invalid value for key: choices (cannot be empty)
• { key: 'abc', choices: [] } - Invalid value for key: choices (cannot be empty)
• { key: 'abc', choices: [ 3 ] } - Invalid value for key: choices (if an array, must be of either string or FieldChoiceWithLabelSchema)
• { key: 'abc', choices: [ { label: 'Red', value: '#f00' } ] } - Invalid value for key: choices (if an array of FieldChoiceWithLabelSchema, must provide key sample)
• { key: 'abc', choices: 'mobile' } - Invalid value for key: choices (must be either object or array)
• { key: 'abc', children: [ '$func$2$f$' ] } - Invalid value for key: children (must be array of FieldSchema)

An array or collection of fields.

• Type - array[/FieldSchema]
• Source Code

• [ { key: 'abc' } ]

• {} - Must be an array

An object whose values can only be primitives

• Type - object
• Source Code

• { a: 1, b: 2, c: 3 }
• { a: 1.2, b: 2.2, c: 3.3 }
• { a: 'a', b: 'b', c: 'c' }
• { a: true, b: true, c: false }
• { a: 'a', b: 2, c: 3.1, d: true, e: false }
• { '123': 'hello' }

• { a: {}, b: 2 } - Invalid value for key: a (objects are not allowed)
• { a: [], b: 2 } - Invalid value for key: a (arrays are not allowed)
• { '': 1 } - Key cannot be empty

A path to a file that might have content like module.exports = (z, bundle) => [{id: 123}];.

• Type - object
• Source Code

• { require: 'some/path/to/file.js' }

• {} - Missing required key: require
• { required: 2 } - Invalid value for key: required (must be of type string)

Internal pointer to a function from the original source or the source code itself. Encodes arity and if arguments is used in the body. Note - just write normal functions and the system will encode the pointers for you. Or, provide {source: "return 1 + 2"} and the system will wrap in a function for you.

• Type - oneOf(string, /FunctionRequireSchema, /FunctionSourceSchema)
• Source Code

• '$func$0$f$'
• '$func$2$t$'
• { source: 'return 1 + 2' }
• { require: 'some/path/to/file.js' }

• 'funcy' - Invalid function reference
• { source: '1 + 2' } - Invalid value for key: source (must end with a return statement)
• { source: '1 + 2', require: 'some/path/to/file.js' } - Must be either /FunctionRequireSchema or /FunctionSourceSchema

Source code like {source: "return 1 + 2"} which the system will wrap in a function for you.

• Type - object
• Source Code

• { source: 'return 1 + 2' }
• { args: [ 'x', 'y' ], source: 'return x + y;' }

• { source: '1 + 2' } - Invalid value for key: source (must end with a return statement)

A bank of named functions that you can use in z.hydrate('someName') to lazily load data.

• Type - object
• Source Code

• { hydrateFile: { require: 'some/path/to/file.js' } }

• { '12th': { require: 'some/path/to/file.js' } } - Invalid key (must start with a letter)

A unique identifier for this item.

• Type - string
• Pattern - ^[a-zA-Z]+[a-zA-Z0-9_]*$
• Source Code

• 'vk'
• 'validKey'
• 'ValidKey'
• 'Valid_Key_2'

• '' - Cannot be empty
• 'A' - Minimum of two characters
• '1_Key' - Must start with a letter
• 'a-Key' - Must not use dashes

INTERNAL USE ONLY. Zapier uses this configuration for internal operation locking.

• Type - object
• Source Code

• { key: 'random_key', scope: [ 'account', 'user' ], timeout: 30 }
• { key: '{{bundle.inputData.test_field}}' }

• { key: 'random_key', scope: [ 'zap' ] } - Invalid scope provided: zap.
• {} - Missing required key: key.

List of before or after middlewares. Can be an array of functions or a single function

• Type - oneOf(array[/FunctionSchema], /FunctionSchema)
• Source Code

• { require: 'some/path/to/file.js' }
• [ { require: 'some/path/to/file.js' } ]

• {} - Does not match either /FunctionSchema or an array of such

A representation of a HTTP redirect - you can use the {{syntax}} to inject authentication, field or global variables.

• Type - object
• Source Code

• { method: 'GET', url: 'https://google.com' }

• { method: 'POST', url: 'https://google.com' } - Invalid value for key: method

Reference a resource by key and the data it returns. In the format of: {resource_key}.{foreign_key}(.{human_label_key}).

• Type - string
• Pattern - ^[a-zA-Z0-9_]+\.[a-zA-Z0-9_\s\[\]]+(\.[a-zA-Z0-9_\s\[\]]+(,[a-zA-Z0-9_\s\[\]]+)*)?$
• Source Code

• 'contact.id'
• 'contact.id.name'
• 'contact.id.firstName,lastName'
• 'contact.id.first_name,last_name,email'
• 'contact.Contact Id.Full Name'
• 'contact.data[]id.data[]First Name,data[]Last Name'

• 'Contact List' - Does not match resource_key pattern
• 'Contact.list,find.id' - Does not match foreign_key pattern
• 'Contact.list.id.full_name' - Does not match human_label_key pattern

A representation of a HTTP request - you can use the {{syntax}} to inject authentication, field or global variables.

• Type - object
• Source Code

• { method: 'GET', url: 'https://zapier.com' }

• { method: 'SUPERCHARGE', url: 'https://zapier.com' } - Invalid value for key: method

How will we find create a specific object given inputs? Will be turned into a create automatically.

• Type - object
• Source Code

• {
    display: { label: 'Create Tag', description: 'Create a new Tag in your account.' },
    operation: { perform: '$func$2$f$', sample: { id: 1 } }
  }
  

• {
    display: {
      label: 'Create Tag',
      description: 'Create a new Tag in your account.',
      hidden: true
    },
    operation: { perform: '$func$2$f$' }
  }
  

• {
    display: { label: 'Create Tag', description: 'Create a new Tag in your account.' },
    operation: { perform: '$func$2$f$' }
  }
  
  Missing key from operation: sample. Note – this is valid if the resource has defined a sample.

How will we get a single object given a unique identifier/id?

• Type - object
• Source Code

• {
    display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
    operation: { perform: { url: '$func$0$f$' }, sample: { id: 385, name: 'proactive enable ROI' } }
  }
  

• {
    display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true },
    operation: { perform: { url: '$func$0$f$' } }
  }
  

• {
    display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
    operation: { perform: { url: '$func$0$f$' } }
  }
  
  Missing key from operation: sample. Note – this is valid if the resource has defined a sample.

How will we get notified of new objects? Will be turned into a trigger automatically.

• Type - object
• Source Code

• {
    display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
    operation: {
      type: 'hook',
      perform: '$func$0$f$',
      sample: { id: 385, name: 'proactive enable ROI' }
    }
  }
  

• {
    display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true },
    operation: { type: 'hook', perform: '$func$0$f$' }
  }
  

• {
    display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
    operation: { type: 'hook', perform: '$func$0$f$' }
  }
  
  Missing key from operation: sample. Note – this is valid if the resource has defined a sample.

How will we get a list of new objects? Will be turned into a trigger automatically.

• Type - object
• Source Code

• {
    display: {
      label: 'New User',
      description: 'Trigger when a new User is created in your account.'
    },
    operation: {
      perform: { url: 'https://fake-crm.getsandbox.com/users' },
      sample: { id: 49, name: 'Veronica Kuhn', email: 'veronica.kuhn@company.com' }
    }
  }
  

• {
    display: {
      label: 'New User',
      description: 'Trigger when a new User is created in your account.',
      hidden: true
    },
    operation: { perform: { url: 'https://fake-crm.getsandbox.com/users' } }
  }
  

• {
    display: {
      label: 'New User',
      description: 'Trigger when a new User is created in your account.'
    },
    operation: { perform: { url: 'https://fake-crm.getsandbox.com/users' } }
  }
  
  Missing key from operation: sample. Note – this is valid if the resource has defined a sample.

How will we find a specific object given filters or search terms? Will be turned into a search automatically.

• Type - object
• Source Code

• {
    display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' },
    operation: { perform: '$func$2$f$', sample: { id: 1 } }
  }
  

• {
    display: {
      label: 'Find a Recipe',
      description: 'Search for recipe by cuisine style.',
      hidden: true
    },
    operation: { perform: '$func$2$f$' }
  }
  

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' },
    operation: { perform: '$func$2$f$' }
  }
  
  Missing key from operation: sample. Note – this is valid if the resource has defined a sample.

Represents a resource, which will in turn power triggers, searches, or creates.

• Type - object
• Source Code

• {
    key: 'tag',
    noun: 'Tag',
    get: {
      display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
      operation: {
        perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' },
        sample: { id: 385, name: 'proactive enable ROI' }
      }
    }
  }
  

• {
    key: 'tag',
    noun: 'Tag',
    sample: { id: 385, name: 'proactive enable ROI' },
    get: {
      display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
      operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } }
    }
  }
  

• {
    key: 'tag',
    noun: 'Tag',
    get: {
      display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true },
      operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } }
    },
    list: {
      display: {
        label: 'New Tag',
        description: 'Trigger when a new Tag is created in your account.'
      },
      operation: {
        perform: { url: 'https://fake-crm.getsandbox.com/tags' },
        sample: { id: 385, name: 'proactive enable ROI' }
      }
    }
  }
  

• {
    key: 'tag',
    noun: 'Tag',
    get: {
      display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
      operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } }
    }
  }
  
  Missing key from operation: sample. Note – this is valid if the resource has defined a sample.

All the resources that underlie common CRUD methods powering automatically handled triggers, creates, and searches for your app. Zapier will break these apart for you.

• Type - object
• Source Code

• {
    tag: {
      key: 'tag',
      noun: 'Tag',
      get: {
        display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
        operation: {
          perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' },
          sample: { id: 385, name: 'proactive enable ROI' }
        }
      }
    }
  }
  

• {
    getTag: {
      key: 'tag',
      noun: 'Tag',
      get: {
        display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
        operation: {
          perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' },
          sample: { id: 385, name: 'proactive enable ROI' }
        }
      }
    }
  }
  
  Key does not match key for associated /ResourceSchema

• {
    tag: {
      key: 'tag',
      noun: 'Tag',
      get: {
        display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' },
        operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } }
      }
    }
  }
  
  Missing key from operation: sample. Note – this is valid if the resource has defined a sample.

An array of objects suitable for returning in perform calls.

• Type - array[object]
• Source Code

• [ { name: 'Alex Trebek' } ]

• 1 - Invalid type (must be array)
• [ 1 ] - Invalid type (must be array of objects)

Alias for /SearchOrCreatesSchema

• Type - object
• Source Code

• {
    searchOrCreateWidgets: {
      key: 'searchOrCreateWidgets',
      display: {
        label: 'Search or Create Widgets',
        description: 'Searches for a widget matching the provided query, or creates one if it does not exist.',
        hidden: false
      },
      search: 'searchWidgets',
      create: 'createWidget'
    }
  }
  

• {
    searchAndCreateWidgets: {
      key: 'searchAndCreateWidgets',
      display: {
        label: 'Search and Create Widgets',
        description: 'Searches for a widget matching the provided query, creates one if it does not exist or updates existing one if found.',
        hidden: false
      },
      search: 'searchWidgets',
      create: 'createWidget',
      update: 'updateWidget'
    }
  }
  

• {
    searchOrCreateWidgets: {
      key: 'socWidgets',
      display: {
        label: 'Search or Create Widgets',
        description: 'Searches for a widget matching the provided query, or creates one if it does not exist.',
        hidden: false
      },
      search: 'searchWidgets',
      create: 'createWidget'
    }
  }
  
  Key must match the key of the associated /SearchOrCreateSchema

Pair an existing search and a create to enable "Find or Create" functionality in your app

• Type - object
• Source Code

• {
    key: 'searchOrCreateWidgets',
    display: {
      label: 'Search or Create Widgets',
      description: 'Searches for a widget matching the provided query, or creates one if it does not exist.',
      hidden: false
    },
    search: 'searchWidgets',
    create: 'createWidget'
  }
  

• {
    key: 'upsertWidgets',
    display: {
      label: 'Upsert Widgets',
      description: 'Searches for a widget matching the provided query and updates it if found, or creates one if it does not exist.',
      hidden: false
    },
    search: 'searchWidgets',
    create: 'createWidget',
    update: 'updateExistingWidget',
    updateInputFromSearchOutput: { widget_id: 'id' },
    searchUniqueInputToOutputConstraint: { widget_name: 'name' }
  }
  

• {
    key: '01_Search_or_Create_Widgets',
    display: {
      label: 'Search or Create Widgets',
      description: 'Searches for a widget matching the provided query, or creates one if it does not exist.',
      hidden: false
    },
    search: 'searchWidgets',
    create: 'createWidget'
  }
  
  Invalid value for key: key (must start with a letter)

• {
    key: 'searchOrCreateWidgets',
    display: {
      label: 'Search or Create Widgets',
      description: 'Searches for a widget matching the provided query, or creates one if it does not exist.',
      hidden: false
    },
    search: { require: 'path/to/some/file.js' },
    create: { require: 'path/to/some/file.js' }
  }
  
  Invalid values for keys: search and create (must be a string that matches the key of a registered search or create)

• {
    key: 'upsertWidgets',
    display: {
      label: 'Upsert Widgets',
      description: 'Searches for a widget matching the provided query and updates it if found, or creates one if it does not exist.',
      hidden: false
    },
    search: 'searchWidgets',
    create: 'createWidget',
    updateInputFromSearchOutput: { widget_id: 'id' },
    searchUniqueInputToOutputConstraint: { widget_name: 'name' }
  }
  
  If either the updateInputFromSearchOutput or searchUniqueInputToOutputConstraint keys are present, then the update key must be present as well.

Enumerates the search-or-creates your app has available for users.

• Type - object
• Source Code

• {
    searchOrCreateWidgets: {
      key: 'searchOrCreateWidgets',
      display: {
        label: 'Search or Create Widgets',
        description: 'Searches for a widget matching the provided query, or creates one if it does not exist.',
        hidden: false
      },
      search: 'searchWidgets',
      create: 'createWidget'
    }
  }
  

• {
    searchAndCreateWidgets: {
      key: 'searchAndCreateWidgets',
      display: {
        label: 'Search and Create Widgets',
        description: 'Searches for a widget matching the provided query, creates one if it does not exist or updates existing one if found.',
        hidden: false
      },
      search: 'searchWidgets',
      create: 'createWidget',
      update: 'updateWidget'
    }
  }
  

• {
    searchOrCreateWidgets: {
      key: 'socWidgets',
      display: {
        label: 'Search or Create Widgets',
        description: 'Searches for a widget matching the provided query, or creates one if it does not exist.',
        hidden: false
      },
      search: 'searchWidgets',
      create: 'createWidget'
    }
  }
  
  Key must match the key of the associated /SearchOrCreateSchema

How will Zapier search for existing objects?

• Type - object
• Source Code

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' },
    operation: { perform: '$func$2$f$', sample: { id: 1 } }
  }
  

• {
    key: 'recipe',
    noun: 'Recipe',
    display: {
      label: 'Find a Recipe',
      description: 'Search for recipe by cuisine style.',
      hidden: true
    },
    operation: { perform: '$func$2$f$' }
  }
  

• 'abc' - Must be an object

• {
    key: 'recipe',
    noun: 'Recipe',
    display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' },
    operation: { perform: '$func$2$f$' }
  }
  
  Missing required key in operation: sample. Note - this is valid if the associated resource has defined a sample.

Enumerates the searches your app has available for users.

• Type - object
• Source Code

• {
    recipe: {
      key: 'recipe',
      noun: 'Recipe',
      display: {
        label: 'Find a Recipe',
        description: 'Search for recipe by cuisine style.',
        hidden: true
      },
      operation: { perform: '$func$2$f$' }
    }
  }
  

• {
    searchRecipe: {
      key: 'recipe',
      noun: 'Recipe',
      display: {
        label: 'Find a Recipe',
        description: 'Search for recipe by cuisine style.',
        hidden: true
      },
      operation: { perform: '$func$2$f$' }
    }
  }
  
  Key must match the key of the associated /SearchSchema

Zapier uses this configuration to apply throttling when the limit for the window is exceeded. NOTE: The final key used for the throttling is formed as a combination of all the configurations; key, window, limit, and scope. To share a limit across multiple actions in an integration, each should have the same configuration set without "action" in the scope.

• Type - object
• Source Code

• { window: 60, limit: 100 }
• { window: 600, limit: 100, scope: [ 'account', 'user' ] }
• { window: 3600, limit: 10, scope: [ 'auth' ] }
• { window: 3600, limit: 10, key: 'random_key', scope: [] }

• {
    window: 3600,
    limit: 10,
    key: 'random_key-{{bundle.inputData.test_field}}',
    scope: [ 'action', 'auth' ],
    retry: false
  }
  

• {
    window: 3600,
    limit: 10,
    scope: [ 'auth' ],
    retry: false,
    overrides: [ { window: 3600, limit: 2, filter: 'free', retry: false } ]
  }
  

• { window: 60, limit: 100, scope: [ 'zap' ] } - Invalid scope provided: zap.
• { limit: 10 } - Missing required key: window.
• { window: 600 } - Missing required key: limit.
• { window: 600, limit: 100, overrides: [] } - The overrides needs at least one item.
• {} - Missing required keys: window and limit.

EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.

• Type - object
• Source Code

• { window: 60, limit: 100, filter: 'free' }
• { window: 60, limit: 100, filter: 'paid', retry: false }
• { window: 60, limit: 100, filter: 'trial', retry: true }

• { limit: 10 } - Missing required key: window and filter.
• { window: 600 } - Missing required key: limit and filter.
• { filter: 'trial' } - Missing required key: window and limit.
• {} - Missing required keys: window, limit, and filter.

How will Zapier get notified of new objects?

• Type - object
• Source Code

• {
    key: 'new_recipe',
    noun: 'Recipe',
    display: { label: 'New Recipe', description: 'Triggers when a new recipe is added.' },
    operation: { type: 'polling', perform: '$func$0$f$', sample: { id: 1 } }
  }
  

• {
    key: 'new_recipe',
    noun: 'Recipe',
    display: {
      label: 'New Recipe',
      description: 'Triggers when a new recipe is added.',
      hidden: true
    },
    operation: { type: 'polling', perform: '$func$0$f$' }
  }
  

• {
    key: 'new_recipe',
    noun: 'Recipe',
    display: { label: 'New Recipe', description: 'Triggers when a new recipe is added.' },
    operation: { perform: '$func$0$f$' }
  }
  
  Missing required key from operation: sample. Note - this is valid if the Recipe resource has defined a sample.

Enumerates the triggers your app has available for users.

• Type - object
• Source Code

• {
    newRecipe: {
      key: 'newRecipe',
      noun: 'Recipe',
      display: { label: 'New Recipe', description: 'Triggers when a new recipe is added.' },
      operation: { type: 'polling', perform: '$func$0$f$', sample: { id: 1 } }
    }
  }
  

• {
    newRecipe: {
      key: 'new_recipe',
      noun: 'Recipe',
      display: { label: 'New Recipe', description: 'Triggers when a new recipe is added.' },
      operation: { type: 'polling', perform: '$func$0$f$', sample: { id: 1 } }
    }
  }
  
  Key must match the key on the associated /TriggerSchema

Represents a simplified semver string, from 0.0.0 to 999.999.999.

• Type - string
• Pattern - ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$
• Source Code

• '1.0.0'
• '2.11.3'
• '999.999.999'

• '1.0.0.0' - Must have only 2 periods
• '1000.0.0' - Each number can be a maximum of 3 digits
• 'v1.0.0' - No letters allowed
• '1.0.0-beta' - undefined