Versions

Versions of your app allow the developer to test and build new features without interrupting existing users.

Features like Auth, Triggers, etc are associated with the version of the app.

API reference: https://documenter.getpostman.com/view/4420537/SzKPVMRx?version=latest#9ba585f3-8ea0-4424-b7ad-122699506f3f

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
id	Unique identifier for this app	Integer	Yes	No	Yes	No	No
appId	Unique identifier for app	Integer	Yes	No	No	No	No
version	Represents the version string	String	Yes	No	No	Follow a pattern: 0.0.0 to 999.999.999	No
authentication	Configuration of Authentication used by the app version	Object	No	Yes	No	No	No
environment	Key-Value pairs of secret values to manage configurations	Object	No	Yes	No	No	No
inviteUrl	Allows anyone to use the app by having them join through this link	text	Yes	No	Yes	Follow a pattern: URL	No
oAuthRedirectUrl	OAuth redirect Url for integration	text	Yes	No	Yes	Follow a pattern: URL	No
createdAt	App creation date	Date	Yes	No	No	No	No
updatedAt	Last updated date	Date	Yes	Yes	No	No	No

The Authentication Object

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
authentication.test	Details required for testing auth credentials	Object	yes	yes	no	no	Yes(Authentication)
authentication.field	Fields to be requested from the User to be able to connect to the app	Array[Object]	no	yes	no	no	Yes(Authentication)
authentication.oauth2Config	Details of the auth configuration	Object	no	yes	no	no	Yes(Authentication)
authentication.oauth1Config	Config for OAuth1 authentication.	Object	no	yes	no	no	Yes(Authentication)
authentication.type	Type of authentication used	enum[oauth2, API key, Session auth, basic auth, digest auth]	yes	no	no	no	Yes(Authentication) [oauth2, API key, Session auth, basic auth, digest auth]
authentication.connectionLabel	label used to differentiate between different app accounts	Text	no	no	no	no	Yes(Authentication)

The Test Object

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)
test.url	Endpoint used to validate auth configurations	Text	yes	yes	no	no
test.method	Http method used by the test endpoint	Text	yes	yes	no	no
test.params	Value passed in the url as request params	Object	no	yes	no	no
test.headers	Header values passed in the request to test endpoint	Object	no	yes	no	no
test.body	Request body to be sent while hitting the test endpoint	Object	no	yes	no	no

The fields Object

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)
field.computed	Whether the value is computed or not	Boolean	yes	no	no	no
field.required	Whether the field is required or not	Boolean	yes	yes	no	no
field.label	The name used to identify the field	Text	yes	yes	no	no
field.helptext	Text for user to identify what value to be given	Text	no	yes	no	no
field.key	Key name required for the input field in APIs	Text	yes	yes	no	no
field.default	Default value to be used if no value is provided by the use	Text	no	yes	no	no

The oAuth1Config Object

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
oauth1Config.authorizeUrl	Defines where we will redirect the user to authorize our app.	Object	Yes	Yes	No	No	Yes(Authentication)
oauth1Config.getAccessToken	Defines how we will fetch an access token from the API	Object(Request )	Yes	Yes	No	No	Yes(Authentication)
oauth1Config.getRequestToken	Defines how to acquire a request token	Object(Request )	No	Yes	No	No	Yes(Authentication)

The oAuth2Config Object

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
oauth2Config.authorizeUrl	Defines where we will redirect the user to authorize our app.	Object	Yes	Yes	No	No	Yes(Authentication)
oauth2Config.getAccessToken	Defines how we will fetch an access token from the API	Object(Request )	Yes	Yes	No	No	Yes(Authentication)
oauth2Config.refreshAccessToken	Defines how we will refresh the access token from the API	Object(Request )	No	Yes	No	No	Yes(Authentication)
oauth2Config.scope	Limiting access to app’s data	short-text	No	Yes	No	No	Yes(Authentication)
oauth2Config.autoRefresh	On expiration of login, if we should invoke refreshAccessToken	Boolean	No	Yes	No	No	Yes(Authentication)

The authorizeUrl Object

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
oauth2Config.authorizeUrl.url	A URL for the request	text	No	Yes	No	Follow a pattern: URL	No
oauth2Config.authorizeUrl.method	The HTTP method for the request	enum[GET, POST, PUT etc.]	No	Yes	No	No	No
oauth2Config.authorizeUrl.params	A mapping of the querystring - will get merged with any query params in the URL	Object	No	Yes	No	No	No

The Request Object

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
method	The HTTP method for the request.	enum[GET,PUT,POST etc]	No	Yes	No	No	No
body	The body of the request	JSON Object	No	Yes	No	No	No
url	A URL for the request	text	No	Yes	No	No	No
headers	The HTTP headers for the request	Object	No	Yes	No	No	No
params	A mapping of the querystring - will get merged with any query params in the URL	Object	No	Yes	No	No	No

Apps and Automations

Versions

The Authentication Object

The Test Object

The oAuth1Config Object

The oAuth2Config Object

The authorizeUrl Object

The Request Object

Related content