TRIGGERS

Trigger powered by either a webhook subscription that watches for new data as it comes in or a polling GET API call to check for new data periodically.

API reference : https://documenter.getpostman.com/view/4420537/SzKPVMRx?version=latest#ea1f9b23-41c8-4a80-b347-68e5c4966698

The Triggers Primary Object

composite key : app_id,key

Filed Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value

Filed Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value
version	Version of trigger	integer	Yes	No	Yes		Version
App	Refer app for a trigger	integer	Yes	No	Yes		App
Trigger.{{key}}	A unique identifier for this trigger	Object	Yes	Yes	Yes	Yes [no space allowed]
Name	A human friendly plain text name for this trigger	var char	Yes	Yes	No	No
trigger.{{key}}.noun	What is the object or item in the name above that this trigger provides?	short-text(eg: Inventory)	Yes	Yes	No	No
trigger.{{key}}.display.description	Describe clearly the purpose of this trigger in a complete sentence.	Text	No	Yes	No	No
Trigger.{{key}}.type	Type of Trigger	enum [restHook,pooling]	Yes	Yes	No	No	RestHook : used for real time data push to action app. Pooling: call a api in defined interval of time to get the data.
Trigger..{{key}}.operation	operation in trigger	Object	No	Yes	No	No	No
Trigger.{{key}}.display.label	A short label	short-text	Yes	Yes	No	No	No
Trigger.{{key}}.display	Define how this Trigger method will be exposed in the UI	Object	No	Yes	No	No	No
trigger.{{key}}.display.hidden	Affects how prominently this operation is displayed in the UI.	Boolean	No	Yes	No	No	No

Trigger.operation :

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value
operation.performSubscribe	Subscribe a webhook	Object	No	Yes	No	No	No
operation.performUnsubscribe	unsubscribe a webhook
operation.performList	Collect sample data same as push on registered webhook
operation.inputFields	The form user sees and configures while making zap	Array[Object]	No	Yes	No	No	No
operation.sample	Sample body of trigger data	[Object]	No	Yes	No	No	No
operation.outputFields	fields returned by trigger data	Array[Object]	No	Yes	No	No	No
operation.type	type of operation on trigger	boolean [restHook,polling]	Yes	Yes	No	No	No

performSubscribe: HOOK TYPE

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value
performSubscribe.body	create webhook POST body	Object	No	Yes	No	No	No
performSubscribe.url	webhook registration URL	Text	Yes	Yes	No	No	No
performSubscribe.headers	headers to pass for webhook registration	Object	No	No	No	No	No
performSubscribe.params	params to pass for webhook registration	Object	No	Yes	No	No	No
performSubscribe.method	Sample body of trigger data	Object	No	Yes	No	No	No

performList :

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value
performList.url	perform api after webhook registration to get sample webhook Post data	Text	Yes	Yes	No	No	No
performList.method	Api method (GET)	varchar	Yes	Yes	No	No	No
performList.params	params of api	OBJECT	No	No	No	No	No
performList.headers	Headers of api	OBJECT	No	Yes	No	No	No
performList.body	Body of api	Object	No	Yes	No	No	No

performUnsubscribe :

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value

Field Name	Business Purpose	Field type (with size) Rich text Text (short text, long text) Number (integer, decimal) Date and Time Location Media Boolean enum [value1, value 2] Array[of what] JSON object Reference	Is it a required field?	Is it editable?	Is it Unique?	Specific validations for some field type Text (short-text, long text)- Character count, a specific pattern (URL, email, slug, custom) prohibit pattern Media (file type, image dimensions, file size)	REFERENCE OF OTHER BUILDING BLOCK Accept only specified values. If Yes, mention what values. In case values are to be filled by reference to records in other datastore - mention the reference to records In case there is the condition, mention the condition In case of enum and Boolean, explain meaning of each enum value or boolean value
performUnsubscribe.url	URL for Unsubscribe a webhook	Text	Yes	Yes	No	No	No
performUnsubscribe.method	Api method (DELETE)	varchar	Yes	Yes	No	No	No
performUnsubscribe.params	params of api	OBJECT	No	No	No	No	No
performUnsubscribe.headers	Headers of api	OBJECT	No	Yes	No	No	No
performUnsubscribe.body	Body of api	Object	No	Yes	No	No	No

Apps and Automations

TRIGGERS

The Triggers Primary Object

Related content