All the search-or-create combos for your app. You can create your own here, or Zapier will automatically register any from resources that define a search, a create, and a get (or define a searchOrCreate directly). Register non-resource search-or-creates here as well.

Details

Properties

Optionally reference and extends a resource. Allows Zapier to automatically tie together samples, lists and hooks, greatly improving the UX. EG: if you had another trigger reusing a resource but filtering the results.

Details

Properties

Optionally reference and extends a resource. Allows Zapier to automatically tie together samples, lists and hooks, greatly improving the UX. EG: if you had another trigger reusing a resource but filtering the results.

Optionally reference and extends a resource. Allows Zapier to automatically tie together samples, lists and hooks, greatly improving the UX. EG: if you had another trigger reusing a resource but filtering the results.

Can get “live” data on demand instead of waiting for a hook. If you find yourself reaching for this - consider resources and their built-in hook/list methods. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, you can ignore warnings about this property with the --without-style flag during zapier push.

Takes a URL and any necessary data from the user and subscribes. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, you can ignore warnings about this property with the --without-style flag during zapier push.

Takes a URL and data from a previous subscribe call and unsubscribes. Note: this is required for public apps to ensure the best UX for the end-user. For private apps, you can ignore warnings about this property with the --without-style flag during zapier push.

Details

Properties

Optionally reference and extends a resource. Allows Zapier to automatically tie together samples, lists and hooks, greatly improving the UX. EG: if you had another trigger reusing a resource but filtering the results.

Properties

Optionally reference and extends a resource. Allows Zapier to automatically tie together samples, lists and hooks, greatly improving the UX. EG: if you had another trigger reusing a resource but filtering the results.

/DynamicFieldsSchema

Details

Examples

[]

[ { key: 'abc' } ]

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

[ '$func$2$f$', '$func$2$f$' ]

Anti-Examples

[ {} ]

[ { key: 'abc', choices: {} } ]

'$func$2$f$'

/FieldChoiceWithLabelSchema

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).

/FunctionRequireSchema

Details

Examples

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

Properties

Key

Required

Type

Description

require

yes

string

No description given.

/FunctionSchema

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.

An object holding the auth parameters for OAuth1 request signing, like {oauth_token: 'abcd', oauth_token_secret: '1234'}. Or an array reserved (i.e. not implemented yet) to hold the username and password for Basic Auth. Like ['AzureDiamond', 'hunter2'].

removeMissingValuesFrom

no

object

Should missing values be sent? (empty strings, null, and undefined only — [], {}, and false will still be sent). Allowed fields are params and body. The default is false, ex: removeMissingValuesFrom: { params: false, body: false }

/ResourceMethodCreateSchema

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