Common GraphQL Inputs

Input types are the objects you pass as arguments to queries and mutations, for example a filter, a sort order, or the attributes of a new page. Use this page as a reference for the input types in the Insites GraphQL schema.

Avoid fields marked Deprecated in new code. Where there is a replacement, the note names it.

ActiveRecordReference

Code example:

Fields

ActivitiesSortInput

Code example:

Fields

AddressImport

Code example:

Fields

Name of the defined property.

AggregationField

Code example:

Fields

Sort buckets; default is by doc-count descending.

AggregationSort

Code example:

Fields

ApiCallNotificationInputType

Code example:

Fields

Liquid code which can be used to process the response from the endpoint. You have access to "response" variable.

Liquid code to evaluate to whatever you want to send as a request body, for example a JSON.

Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Ids of forms which should trigger the api call.

Deprecated, use request_headers.

When true, insites-cli deploy and sync do not change this object.

Deprecated - derived from physical_file_path; name of the api call, which is used in forms or mutation to trigger it.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/api_calls/my_api_call_notification.

Liquid code which should evaluate to valid request type: Get, Post, Put, Patch, Delete, Head or if you want to send binary files: Post_Multipart, Put_Multipart, Patch_Multipart.

Liquid code to evaluate to valid endpoint for the request.

Liquid code which should evaluate to true if the api call should be sent.

ApiCallNotificationsFilterInput

Code example:

Fields

Deprecated - use delay_by.

Filter by metadata properties.

ApiCallNotificationsSortInput

Code example:

Fields

ApiCallSendOptions

Code example:

Fields

If set to true, no charge will be applied and the request will be made against the current Stack. If the instance is on a different Stack, 404 will be returned.

If set to true, SSL certificate verification will be skipped for HTTPS requests.

Read timeout of HTTP request in seconds. For calls triggered from background jobs default is 8s and max 180s. For calls triggered from web request default is 5s and max 5s.

ApiCallSendRequestInput

Input for API call request details.

Fields

The body of the API call, delivered verbatim - it is not parsed as a Liquid template and may contain binary data (e.g. an encrypted Web Push payload built with the base64_decode filter).

Headers for the API call.

The HTTP method for the API call.

The URL for the API call.

AssetInput

Code example:

Fields

Cache-Control header value for the asset (e.g., "max-age=315576000, public").

When true, insites-cli deploy and sync do not change this object.

Metadata hash for the attribute.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/assets/logo.png.

Optional. You can leave it out.

AssetPresignInput

Code example:

Fields

AssetsSortInput

Code example:

Fields

AssetUpdateAllInput

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

AssetUpdateInput

Code example:

Fields

Cache-Control header value for the asset (e.g., "max-age=315576000, public").

When true, insites-cli deploy and sync do not change this object.

Metadata hash for the attribute.

Defines the file location, from which we will extract the name and move the file from old location to the new one.

AtachmentInputType

Code example:

Fields

File URL returned after you upload the file with a pre-signed URL.

Name of the property.

External url to the file.

AttachmentContentLengthRange

Code example:

Fields

AttachmentModelPropertyInput

Code example:

Fields

AttachmentPresignUrlInput

Code example:

Fields

File size limitation in KiB. ex. [gte: 1, lte: 1024] allows file size from 1KiB to 1 MiB.

Choose property which should be used to generate versions, versions defined in yml schema file.

Choose property which should be used to generate versions, versions defined in yml schema file.

AttachmentsImport

Code example:

Fields

Direct path to file on S3.

ID will ignored.

Name of the defined property.

URL to presigned slot on S3.

AttachmentUserPropertyInput

Code example:

Fields

AuthenticationInputType

Code example:

Fields

AuthorizationPoliciesFilter

Code example:

Fields

AuthorizationPoliciesFilterInput

Code example:

Fields

Filter by metadata properties.

AuthorizationPoliciesSortInput

Code example:

Fields

AuthorizationPolicyInputType

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

Deprecated - derived from physical_file_path.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/authorization_policies/my_policy.

BackgroundJobsFilterInput

Code example:

Fields

Deprecated.

Deprecated.

Deprecated.

Deprecated.

OR conditions.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

It filters based on: run_at - for SCHEDULED type; retry_at - for RETRY type; dead_at - for DEAD type. It is ignored for RUNNING type.

Type of jobs to retrieve.

BackgroundJobsSortInput

Code example:

Fields

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

BooleanFilter

Code example:

Fields

Filter whether value was not set.

Content

Code example:

Fields

Content type should start with this value.

Content type should have this value.

ContentLength

Code example:

Fields

Greater than or equal size in KiB.

Lower than or equal size in KiB.

ContentLengthRange

Code example:

Fields

CustomAttachmentInputType

Code example:

Fields

Attribute of type file with which the created attachment should be associated - must be defined in the schema of the record, for example CustomModelType for Customization, InstanceProfileType for UserProfile or user.yml for User.

URL to image that was uploaded to s3 presigned url.

Allows you to create attachment with your own content; useful for generating reports, pdf, csv etc.

Id of associated record - Model, UserProfile, User.

Class of associated record - Model, UserProfile, User.

Deprecated, ignore.

Create attachment based on a file available on remote location.

Id of a user who uploads the attachment.

CustomAttributeInputType

Code example:

Fields

Adds provided value at the end of an array property. It's secure atomic operation executed in separate transaction.

Removes provided value from an array property. It's secure atomic operation executed in separate transaction.

Decrements property value by provided value. It's secure atomic operation executed in separate transaction.

Increments property value by provided value. It's secure atomic operation executed in separate transaction.

CustomImageInputType

Code example:

Fields

URL to image that was uploaded to s3 presigned url.

Id of associated record - Customization, UserProfile, User.

Class of associated record - Customization, UserProfile, User.

Deprecated.

Id of the user who uploads the attachment.

CustomizationImport

Code example:

Fields

ID will be stored as external_id, relations will be preseved. We generate it when empty.

Ex. {"color": "red"}.

CustomizationInputType

Code example:

Fields

Deprecated, use model_schema_name.

Deprectated, use properties.

CustomizationsInputType

Code example:

Fields

CustomizationSortOrder

Code example:

Fields

Sort by given field value.

Sort by given property value.

CustomizationsSortOrder

Code example:

Fields

Sort by field name.

Sort by property field.

DataExportModelsInput

Code example:

Fields

DataExportRecordsInput

Code example:

Fields

DataExportsFilterInput

Code example:

Fields

DataExportsSortInput

Code example:

Fields

DataExportUsersInput

Code example:

Fields

DateFilter

Code example:

Fields

DateRange

Code example:

Fields

DefaultProfileInputType

Code example:

Fields

EmailNotificationInputType

Code example:

Fields

Json of the form { "file_name.jpg": { "url": "http://example.com/file.jpg" } } which defines email attachments. Liquid will be processed.

Liquid code to evaluate to valid, comma separated blind carbon copy list, for example "john@example.com, jane@example.com".

Liquid code to evaluate to valid, comma separated carbon copy list, for example "john@example.com, jane@example.com".

Liquid code to evaluate to valid form html. If email is triggered via form configuration, You have access to "form" variable, with data specified in configuration.

Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Ids of forms which should trigger the email.

Email address from which you would like to send the email, for example notifications@mydomain.com.

Name of the liquid layout to which the content should be injected.

Deprecated, use layout.

When true, insites-cli deploy and sync do not change this object.

Deprecated - derived from physical_file_path; name of the email, which is used in form or mutation to trigger it.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/emails/my_email_notification.

Email address to which users should reply, for example support@mydomain.com.

Liquid code to evaluate to text.

Liquid code to evaluate to valid, comma separated recipient list, for example "john@example.com, jane@example.com".

Liquid code which should evaluate to true if the email should be sent.

EmailNotificationsFilterInput

Code example:

Fields

Deprecated - use delay_by.

Deprecated - use layout.

Filter by metadata properties.

EmailNotificationsSortInput

Code example:

Fields

EmbeddingCreateInputType

Code example:

Fields

Vector with 1536 dimensions, compatible with openai embeddings.

EmbeddingsFilterInput

Code example:

Fields

Filter by metadata properties.

EmbeddingsSortInput

Code example:

Fields

EmbeddingUpdateInputType

Code example:

Fields

Vector with 1536 dimensions, compatible with openai embeddings.

EncryptedConstantFilterInput

Code example:

Fields

EncryptedConstantsFilterInput

Code example:

Fields

EncryptedConstantsSortInput

Code example:

Fields

Endpoint

Code example:

Fields

Authentication token.

Endpoint url.

FormConfigurationInputType

Code example:

Fields

Same as callback, but invoked asynchronously. Recommended for performance reason.

Liquid code which should evaluate to float. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Defines max number of retrying attempts in case of an error. Usually you do not want to change it.

Defines the invocaction priority, the higher the quicker timeout.

Ids of authorization policies which should be checked.

Liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead.

Whitelist of attributes which can be persisted in the DB. On server side (callbacks, emails etc) you have access to submited values via form variable (for exapmple configuration: properties: my_var is accessible via form.properties.my_var ).

Liquid code which has to evaluate to JSON. This extends/overwrites user submitted input via form, before validation. Most useful to store in DB sensitive data which you do not want user to modify, for example context.current_user.id.

Liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert.

Liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice.

Liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/form_configurations/my_form_configuration.

Liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.

Defines who can submit the form. If set to anyone, please make sure to provide authorization_policies.

Strategy to protect against spam attacks.

FormConfigurationsFilterInput

Code example:

Fields

Filter by metadata properties.

FormConfigurationsSortInput

Code example:

Fields

FormInput

Code example:

Fields

Same as callback, but invoked asynchronously. Recommended for performance reason.

Liquid code which should evaluate to float. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Defines max number of retrying attempts in case of an error. Usually you do not want to change it.

Defines the invocaction priority, the higher the quicker timeout.

Ids of authorization policies which should be checked.

Liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead.

Whitelist of attributes which can be persisted in the DB. On server side (callbacks, emails etc) you have access to submited values via form variable (for exapmple configuration: properties: my_var is accessible via form.properties.my_var ).

Liquid code which has to evaluate to JSON. This extends/overwrites user submitted input via form, before validation. Most useful to store in DB sensitive data which you do not want user to modify, for example context.current_user.id.

Liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert.

Liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice.

Liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.

Deprecated - derived from physical_file_path.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/forms/my_form.

Liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.

Defines who can submit the form. If set to anyone, please make sure to provide authorization_policies.

Response headers for the form.

Strategy to protect against spam attacks.

FormsFilterInput

Code example:

Fields

Filter by metadata properties.

FormsSortInput

Code example:

Fields

FullTextQueryField

Code example:

Fields

GeoBox

Code example:

Fields

GeoBoxTopLeftBottomRight

Code example:

Fields

GeoBoxTopRightBottomLeft

Code example:

Fields

GeoPoint

Code example:

Fields

GeoPointInShape

Code example:

Fields

GeoPolygon

Code example:

Fields

Remember to keep right order, follow GeoJSON spec.

GeoPropertyFilterInput

Code example:

Fields

GeoJSON Object: of type Point, MultiPoint, LineString, Polygon. example: `{ type: "Point", coordinates: [-84.3, 39.8] }`.

Distance in km.

GeoQuery

Code example:

Fields

GeoRadius

Code example:

Fields

Ex. 1km, 100mi, 50yards, 2meters.

GeoRadiusPropertyFilterInput

Code example:

Fields

GeoJSON Object: of type Point, MultiPoint, LineString, Polygon. example: `{ type: "Point", coordinates: [-84.3, 39.8] }`.

Property name with value for radius distance. Property has to be of float type. Value has to be `km` unit.

GraphqlFilterInput

Code example:

Fields

Filter by metadata properties.

GraphqlInputType

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example graphql/my_query.graphql.

GraphqlSortInput

Code example:

Fields

IdRangeFilter

Code example:

Fields

ImageInputType

Code example:

Fields

External url to the image.

Image URL returned after you upload the image with a pre-signed URL.

Name of the property.

External url to the image.

ImagePresignUrlInput

Code example:

Fields

File size limitation in KiB. ex. [gte: 1, lte: 1024] allows file size from 1KiB to 1 MiB.

Choose property which should be used to generate versions, versions defined in yml schema file.

Choose property which should be used to generate versions, versions defined in yml schema file.

Deprecated.

ImagesFilterInput

Code example:

Fields

ImagesImport

Code example:

Fields

Direct path to file on S3.

ID will ignored.

Name of the defined property.

URL to presigned slot on S3.

ImagesSortInput

Code example:

Fields

IndexSearchFilterInput

Code example:

Fields

If argument is true, selects documents for which the property exists and is not null; if argument is false, selects documents for which the property doesn't exist or is null.

Name of the property.

Property specified by name should NOT have a value that is equal to the value provided.

Property specified by name should NOT include a value that is provided.

Property specified by name have a value that is prefixed with provided value.

Selects documents for which the property value is inside the given range; range options that can be given are lt (lower than), lte (lower than or equal), gt (greater than), gte (greater than or equal).

Property specified by name should have a value that is equal to the value provided.

Property specified by name should include a value that is provided.

ALL values should be included in document OR one is enough.

IndexSearchQuery

Code example:

Fields

Keyword analyzer: english arabic etc. Depends on your search index configuration. Default: standard.

Accept wildcards, ? for single character, * for more.

IndexSearchSortInput

Code example:

Fields

Sort by field.

IntegerFilter

Code example:

Fields

IntegerRangeFilter

Code example:

Fields

JoinModelCollection

Code example:

Fields

JoinRecordCollection

Code example:

Fields

JsonbAttributeFilter

Code example:

Fields

The target value must contain the passed array.

The value in the target array must have at least one element in common with the passed array.

The passed array must contain the target array.

The target value must not contain the passed array.

The value in the target array must not have at least one element in common with the passed array.

The passed array must not contain the target array.

The value passed must not be the exact target array in that order.

The passed array must not contain the target scalar value.

The value passed must be the exact target array in that order.

The passed array must contain the target scalar value.

JsonbFilter

Code example:

Fields

Filter by attribute key and value. Works for one level attributes.

Filter by attributes - key and value. Works for one level attribute.

Filter metadata that contains part of the text.

Exclude matched resources from results.

Filter resources that have certain key in metadata.

JsonbSort

Code example:

Fields

Name of the first level metadata attribute.

LiquidLayoutInputType

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/layouts/my_layout.

LiquidLayoutsFilterInput

Code example:

Fields

Filter by metadata properties.

LiquidLayoutsSortInput

Code example:

Fields

LiquidPartialInputType

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/partials/my_partial.

LiquidPartialsFilterInput

Code example:

Fields

Filter by metadata properties.

LiquidPartialsSortInput

Code example:

Fields

ListingAggregation

Code example:

Fields

Name of the result.

ModelPropertyInput

Code example:

Fields

ModelSchemaInputType

Code example:

Fields

Deprecated, use properties.

Deprecated - derived from physical_file_path.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/custom_model_types/my_model.

ModelSchemasFilterInput

Code example:

Fields

Filter by metadata properties.

ModelSchemasSortInput

Code example:

Fields

ModelsFilterInput

Code example:

Fields

Deprecated, use `related_models`.

Deprecated, use model_schema_name.

Join arguments with OR operator.

Filter by related models.

Deprecated, use `related_users`.

ModelsSortInput

Code example:

Fields

ModelUpdate

Code example:

Fields

ID must match existing object id.

Ex. {"color": "red"}.

MutationAssetsFilterInput

Code example:

Fields

Filter by metadata properties.

NestedCustomizationFilters

Code example:

Fields

Name of the Model Schema.

NestedPropertyInputType

Code example:

Fields

Provide 1 if property you want to remove property, 0 otherwise.

Type of the property.

Defines a relationship with other model schema or the user schema. Used during importing/exporting data.

Default value for new objects.

Id of the property to update.

Name of the property.

Provides options for type upload - defines for exmple whether newly upload file should be public etc.

NewCustomImageInputType

Code example:

Fields

URL to image that was uploaded to s3 presigned url.

Valid values: Customization, User, UserProfile.

Deprecated.

Deprecated, use direct_url which is generated via image_presign_url mutation.

NotificationEmailInput

Input type for email parameters.

Fields

BCC email address.

CC email address.

Email body content.

Delay in minutes before sending the email.

Sender email address.

Reply-to email address.

Email subject.

Recipient email address.

NotificationTemplateInput

Code example:

Fields

Name of the template.

NotificationTypeFilter

Code example:

Fields

PageFilterInput

Code example:

Fields

Filter by authorization policies, ex. authorization_policies: { value_in: ["page_protection", "check_user"] }.

Search for text in rendered page content. Page must be marked as searchable.

Filter by format, ex. format: { value: HTML }.

Deprecated - use layout.

Filter by metadata properties.

Join arguments with OR operator.

Request method for the page.

Filter by slug. Enter slug without leading /, ex. slug: { exact: "client/orders" }.

PageFormatFilter

Code example:

Fields

PageInputType

Code example:

Fields

Names of authorization policies which should be checked (the same identifier used in Liquid frontmatter, e.g. "page_policy" or "modules/my_module/page_policy"). Can be used instead of (or combined with) authorization_policy_ids. All names must resolve to existing AuthorizationPolicy records.

Ids of authorization policies which should be checked.

Name of the liquid layout to which the content should be injected.

Deprecated, use layout.

When true, insites-cli deploy and sync do not change this object.

Max nesting of the url to be resolved by this slug. For example slug "abc" with max_deep_level 2 will resolve /abc, abc/1, abc/2, but will NOT resolve abc/2/something.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/pages/my-page.

Defines the url at which the page will be available, for example if you want the page to be available at https://example.com/hello/world set the slug to hello/world. If blank, slug will be derived from physical_file_path, in this example set physical_file_path to views/pages/hello/world.html.liquid.

Subdomain for page.

PagesRequestMethodFilter

Code example:

Fields

PagesSortInput

Code example:

Fields

PresignUrl

Code example:

Fields

ACL for the uploaded file.

Size range for the uploaded file.

Content type for the uploaded file.

PresignUrlInput

Code example:

Fields

Defines whether it is a public file that anyone who knows the url can access it, or if its private and even with the known URL it is not possible to see the file without a signature.

File size limitation in KiB. ex. [gte: 1, lte: 1024] allows file size from 1KiB to 1 MiB.

If image is uploaded, multiple versions of it will be generated automatically.

ProcessPageInputType

Code example:

Fields

Parameters you would like to pass to the page to render it dynamically. They will beavailable via context.params.

Slug of the page which you would like to use as a template.

ProcessStrategyInputType

Code example:

Fields

Expected content depends on strategy, however usually it is text, html, csv, json, xml etc.Alternativey you can process page via page argument.

Name of the output file.

Provided page will be rendered and its output will be used as a body. Alternatively you can pass body directly via body argument.

If you set to true and strategy requires asynchronous processing by us (like pdf generation) then the mutation will wait until the file is actually generated so you can for example attach it to an email.

ProfileFilterInput

Code example:

Fields

Name of the user profile type.

Name of the user profile type.

PropertiesFieldInput

Code example:

Fields

PropertyFilterInput

Code example:

Fields

Allow empty values.

Selects records for which the property of type Array contains all of the provided elements.

Selects records for which the property of type Array contains at least one of the provided elements.

If argument is true, contains, starts_with and ends_with will be case sensitive.

Selects records where the property of type String contains the provided string as a sub-string (control case sensitivity with `case_sensitive` argument).

Select records for which a distance between its point from <:property> and <:center> point is less than <:distance>.

Selects records for which the property of type String ends with the provided argument (control case sensitivity with `case_sensitive` argument).

If argument is true, selects records for which the property exists and is not null; if argument is false, selects records for which the property doesn't exist or is null.

Name of the property.

Selects records for which the property of type Array may contain some, but not all of the provided elements.

Selects records for which the property of type Array doesn't have any element in common with the provided array of elements.

Selects records where the property of type String does not contain the provided string as a sub-string (control case sensitivity with `case_sensitive` argument).

Selects records for which the property of type String does not end with the provided argument (control case sensitivity with `case_sensitive` argument).

Selects records for which the property of type String does not start with the provided argument (control case sensitivity with `case_sensitive` argument).

Property specified by name should have a value that is different from the value provided.

Selects records for which the property of type Array is not equal to the provided value.

Property specified by name should be different from the value provided.

Property specified by name should different from the value provided.

Selects records for which the property is not included as a sub-array or is not an element of the provided Array argument.

Property specified by name should be equal different from the value provided.

Select records for which a <:point> is not within <:radius_in_km_from_property> km distance from its <:property> point.

Specifies the type of the property if it can't be determined automatically.

Selects records for which the property value is inside the given range; range options that can be given are lt (lower than), lte (lower than or equal), gt (greater than), gte (greater than or equal).

Selects records for which the property of type String starts with the provided argument (control case sensitivity with `case_sensitive` argument).

Property specified by name should have a value that is equal to the value provided.

Selects records for which the property of type Array is equal to the provided value.

Property specified by name should be equal to the value provided.

Property specified by name should be equal to the value provided.

Selects records for which the property is included as a sub-array or is an element of the provided Array argument.

Property specified by name should be equal to the value provided.

Select records for which a <:point> is within <:radius_in_km_from_property> km distance from its <:property> point.

PropertyInputType

Code example:

Fields

Adds provided value at the end of an array property. It's secure atomic operation executed in separate transaction.

Removes provided value from an array property. It's secure atomic operation executed in separate transaction.

Decrements property value by provided value. It's secure atomic operation executed in separate transaction.

Increments property value by provided value. It's secure atomic operation executed in separate transaction.

PropertySort

Code example:

Fields

PropertyUploadContentLengthInput

Code example:

Fields

PropertyUploadEncryptionGPGInput

Code example:

Fields

Create ASCII armored output. The default is to create the binary OpenPGP format.

Public key to be used to encrypt the file.

PropertyUploadEncryptionInput

Code example:

Fields

Encrypt using GnuPG Public Key.

PropertyUploadManipulateInput

Code example:

Fields

Value representing the sigma of the Gaussian mask, where sigma = 1 + radius / 2.

Color for flatten.

Convert to 8-bit greyscale; 256 shades of grey.

PropertyUploadOptionsInput

Code example:

Fields

File size limitation in KiB. ex. [gte: 1, lte: 1024] allows file size from 1KiB to 1 MiB.

Defines a version of the uploaded image - for example you might want to resize it for performance reason, compress etc. Max number of versions is 10.

PropertyUploadOutputInput

Code example:

Fields

Defines the quality of the image; used to automatically compress the image; 0 - lowest quality, 100 - highest quality. Defaults: PNG: 80, WEBP: 80, JPEG: 85, AVIF: 60.

PropertyUploadResizeInput

Code example:

Fields

Background color when using a fit of containDefault: #000000.

Max height of an image. If left undefined, will depend on other parameters to determine size (like: width).

Position to use when fit is cover or contain.

Max width of an image. If left undefined, will depend on other parameters to determine size (like: height).

Do not enlarge if the width or height are already less than the specified dimensions.

PropertyUploadVersionInput

Code example:

Fields

Name of the version, for example thumb.

Query

Code example:

Fields

Accept wildcards, ? for single character, * for more.

Search all fields as raw.

QueryAssetsFilterInput

Code example:

Fields

Filter by metadata properties.

QueryCustomAttribute

Code example:

Fields

Set it when you want to exclude value/values/range from results.

QueryCustomization

Code example:

Fields

Need to narrow profiles by profile_type.

QueryCustomModelType

Code example:

Fields

QueryListing

Code example:

Fields

Do not use this please.

QueryListingLocation

Code example:

Fields

Geo search.

QueryModelSchema

Code example:

Fields

QueryOptionsInput

Execution options for this query.

Fields

Execute against the read replica database when one is configured; falls back to the primary database otherwise. Routing applies to the whole operation.

Database statement timeout in seconds applied to the whole operation. Defaults to 19 seconds.

QueryTransactableType

Code example:

Fields

QueryUser

Code example:

Fields

QueryUserProfile

Code example:

Fields

Geo search based on searchable custom_addresses.

Name of the user profile type.

Alias for name argument.

Need to narrow profiles by profile_type.

Range

Code example:

Fields

RangeFilter

Code example:

Fields

RecordInputType

Code example:

Fields

RecordsCreateInputType

Code example:

Fields

RecordsFilterInput

Code example:

Fields

Fulltext search.

Join arguments with OR operator.

Filter by related records.

Name of the Table to which records should belong.

ID of the table to which records should belong.

RecordsInputType

Code example:

Fields

RecordsSortInput

Code example:

Fields

RelatedModelsFilterInput

Code example:

Fields

RelatedRecordsFilterInput

Code example:

Fields

RelatedUsersFilterInput

Code example:

Fields

SentNotificationsFilterInput

Code example:

Fields

SentNotificationsSortInput

Code example:

Fields

SmsNotificationInputType

Code example:

Fields

Liquid code to evaluate to valid form html. If sms is triggered via form configuration, You have access to "form" variable, with data specified in configuration.

Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Deprecated, use form_ids.

Ids of forms which should trigger the sms.

Deprecated - derived from physical_file_path;name of the sms, which is used in forms or mutation to trigger it.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/smses/my_sms_notification.

Liquid code to evaluate to valid mobile number with country code, for example +1 541 754 3010. Useful filter to build valid mobile number is "$to_mobile_number".

Liquid code which should evaluate to true if the sms should be sent.

SmsNotificationsFilterInput

Code example:

Fields

Deprecated - use delay_by.

Filter by metadata properties.

SmsNotificationsSortInput

Code example:

Fields

SmsSendInput

Input object for sending an SMS directly.

Fields

The content of the SMS message.

Delay in minutes before sending the SMS.

The recipient phone number.

SortByChildField

Code example:

Fields

Child type, for ex. transactable.

Sort by this field, example: "id".

SortByDistance

Code example:

Fields

Sort by this field, example: "geo_location".

Reference point, usually current location.

SortByFieldOrder

Code example:

Fields

Sort by this field, example: "id".

Sort by provided values, example: [109, 903]. Full example: If { field_name: "id", values: [109, 903] }, Object#109 will be 1st, Object#903 will be 2nd, and then the rest.

SortOrder

Code example:

Fields

Sort by distance to geo point.

Sort by given field by provided values.

Sort by field.

Sort by distance to geo point based on custom_addresses.

To sort by profile property use `properties.` prefix, ex. `profile_field: "properties.color"`.

Sort by profile property`.

Name of the user profile type.

Sort by property field.

SpamProtectionInput

Code example:

Fields

SpamProtectionInputType

Code example:

Fields

SpamProtectionRecaptchaV3Input

Code example:

Fields

SpamProtectionRecaptchaV3InputType

Code example:

Fields

StandalonePropertyInputType

Code example:

Fields

Type of the property.

Defines a relationship with other model schema or the user schema. Used during importing/exporting data.

Default value for new objects.

Name of the property.

Provides options for type upload - defines for exmple whether newly upload file should be public etc.

Id of the schema to which this property definition belongs. For target_type User set to null.

Type of the schema to which this property definition belongs.

StandardSort

Code example:

Fields

Order by specific values.

StringFilter

Code example:

Fields

If argument is true, contains, starts_with and ends_with will be case sensitive.

Matches string within other string.

Deprecated, use "value" instead.

TableInputType

Code example:

Fields

Defines where the table definition will be available after pull; for example schema/my_model.yml.

TablesFilterInput

Code example:

Fields

Filter by metadata properties.

TablesSortInput

Code example:

Fields

ThirdPartyIntegrationsFilterInput

Code example:

Fields

ThirdPartyIntegrationsSortInput

Code example:

Fields

TransactableImport

Code example:

Fields

ID will be changed after import, relations will be preseved.

Ex. {"color": "red"}.

TransactableInputType

Code example:

Fields

TransactableSchemaInputType

Code example:

Fields

Deprecated, use properties.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/transactable_types/my_transactable.

TransactableSchemasFilterInput

Code example:

Fields

TransactableSchemasSortInput

Code example:

Fields

TranslationInputType

Code example:

Fields

For example en, de etc.

When true, insites-cli deploy and sync do not change this object.

TranslationJsonInputType

Code example:

Fields

Path to the translation branch which should be set.

For example en, de etc.

Json with translation tree which should be set.

UniqIdFilter

Code example:

Fields

UpdateApiCallNotificationInputType

Code example:

Fields

Liquid code which can be used to process the response from the endpoint. You have access to "response" variable.

Liquid code to evaluate to whatever you want to send as a request body, for example a JSON.

Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Ids of form configurations which should trigger the api call.

Deprecated, use request_headers.

When true, insites-cli deploy and sync do not change this object.

Name of the api call, which is used in form_configurations or mutation to trigger it.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/notifications/api_call_notifications/my_api_call_notification.

Liquid code which should evaluate to valid request type: Get, Post, Put, Patch, Delete, Head or if you want to send binary files: Post_Multipart, Put_Multipart, Patch_Multipart.

Liquid code to evaluate to valid endpoint for the request.

Liquid code which should evaluate to true if the api call should be sent.

UpdateAuthorizationPolicyInputType

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/authorization_policies/my_policy.

UpdateCustomAttachmentInputType

Code example:

Fields

URL to image that was uploaded to s3 presigned url.

UpdateEmailNotificationInputType

Code example:

Fields

Json of the form { "file_name.jpg": { "url": "http://example.com/file.jpg" } } which defines email attachments. Liquid will be processed.

Liquid code to evaluate to valid, comma separated blind carbon copy list, for example "john@example.com, jane@example.com".

Liquid code to evaluate to valid, comma separated carbon copy list, for example "john@example.com, jane@example.com".

Liquid code to evaluate to valid form html. If email is triggered via form configuration, You have access to "form" variable, with data specified in configuration.

Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Ids of forms which should trigger the email.

Email address from which you would like to send the email, for example notifications@mydomain.com.

Name of the liquid layout to which the content should be injected.

Deprecated, use layout.

When true, insites-cli deploy and sync do not change this object.

Name of the email, which is used in forms or mutation to trigger it.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/emails/my_email_notification.

Email address to which users should reply, for example support@mydomain.com.

Liquid code to evaluate to text.

Liquid code to evaluate to valid, comma separated recipient list, for example "john@example.com, jane@example.com".

Liquid code which should evaluate to true if the email should be sent.

UpdateFormConfigurationInputType

Code example:

Fields

Same as callback, but invoked asynchronously. Recommended for performance reason.

Liquid code which should evaluate to float. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Defines max number of retrying attempts in case of an error. Usually you do not want to change it.

Defines the invocaction priority, the higher the quicker timeout.

Ids of authorization policies which should be checked.

Liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead.

Whitelist of attributes which can be persisted in the DB. On server side (callbacks, emails etc) you have access to submited values via form variable (for exapmple configuration: properties: my_var is accessible via form.properties.my_var ).

Liquid code which has to evaluate to JSON. This extends/overwrites user submitted input via form, before validation. Most useful to store in DB sensitive data which you do not want user to modify, for example context.current_user.id.

Liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert.

Liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice.

Liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/form_configurations/my_form_configuration.

Liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.

Defines who can submit the form. If set to anyone, please make sure to provide authorization_policies.

Strategy to protect against spam attacks.

UpdateFormInput

Code example:

Fields

Same as callback, but invoked asynchronously. Recommended for performance reason.

Liquid code which should evaluate to float. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Defines max number of retrying attempts in case of an error. Usually you do not want to change it.

Defines the invocaction priority, the higher the quicker timeout.

Ids of authorization policies which should be checked.

Liquid code to be invoked after persisting input to DB. If possible, use async callback actions instead.

Whitelist of attributes which can be persisted in the DB. On server side (callbacks, emails etc) you have access to submited values via form variable (for exapmple configuration: properties: my_var is accessible via form.properties.my_var ).

Liquid code which has to evaluate to JSON. This extends/overwrites user submitted input via form, before validation. Most useful to store in DB sensitive data which you do not want user to modify, for example context.current_user.id.

Liquid code which should evaluate to message which you want to display to user upon validation errors. Output is available via context.flash_alert.

Liquid code which should evaluate to message which you want to display to user after successful form submission. Output is available via context.flash_notice.

Liquid code to evaluate to valid form html. You have access to form_builder variable and form tag.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/forms/my_form.

Liquid code which should evaluate to valid path or url to which user should be redirected after successful form submission.

Defines who can submit the form. If set to anyone, please make sure to provide authorization_policies.

Response headers for the form.

Strategy to protect against spam attacks.

UpdateGraphqlInputType

Code example:

Fields

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/partials/my_partial.

UpdateLiquidLayoutInputType

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/layouts/my_layout.

UpdateLiquidPartialInputType

Code example:

Fields

When true, insites-cli deploy and sync do not change this object.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/partials/my_partial.

UpdateModelSchemaInputType

Code example:

Fields

Deprecated, use properties.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/custom_model_types/my_model.

UpdatePageInputType

Code example:

Fields

Names of authorization policies which should be checked (the same identifier used in Liquid frontmatter, e.g. "page_policy" or "modules/my_module/page_policy"). Can be used instead of (or combined with) authorization_policy_ids. All names must resolve to existing AuthorizationPolicy records.

Ids of authorization policies which should be checked.

Name of the liquid layout to which the content should be injected.

Deprecated, use layout.

When true, insites-cli deploy and sync do not change this object.

Max nesting of the url to be resolved by this slug. For example slug "abc" with max_deep_level 2 will resolve /abc, abc/1, abc/2, but will NOT resolve abc/2/something.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/views/pages/my-page.

Slug will not be automatically if you modify physical_file_path, as this operation is dangerous. After changing the slug you might want to ensure the SEO will not be hurt by creeating Page with the old slug and setting the redirect_to property to the new path.

Subdomain for page.

UpdateSmsNotificationInputType

Code example:

Fields

Liquid code to evaluate to valid form html. If sms is triggered via form configuration, You have access to "form" variable, with data specified in configuration.

Liquid code which should evaluate to integer. Delays invoking the job by specified number of minutes. Useful to invoke code at certain point in time, for example 1 hour before something etc. To calculate proper number you can use time_diff filter.

Deprecated, use form_ids.

Name of the sms, which is used in forms or mutation to trigger it.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/smses/my_sms_notification.

Liquid code to evaluate to valid mobile number with country code, for example +1 541 754 3010. Useful filter to build valid mobile number is "$to_mobile_number".

Liquid code which should evaluate to true if the sms should be sent.

UpdateStandalonePropertyInputType

Code example:

Fields

Type of the property.

Defines a relationship with other model schema or the user schema. Used during importing/exporting data.

Default value for new objects.

Name of the property.

Provides options for type upload - defines for exmple whether newly upload file should be public etc.

Id of the schema to which this property definition belongs. For target_type User set to null.

Type of the schema to which this property definition belongs.

UpdateTableInputType

Code example:

Fields

Defines where the table definition will be available after pull; for example schema/my_model.yml.

UpdateTransactableSchemaInputType

Code example:

Fields

Deprecated, use properties.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/transactable_types/my_transactable.

UpdateTranslationInputType

Code example:

Fields

For example en, de etc.

When true, insites-cli deploy and sync do not change this object.

UpdateUserProfileSchemaInputType

Code example:

Fields

Deprecated, use properties.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/user_profile_types/my_user_profile.

UserImport

Code example:

Fields

ID will be stored as external_id, relations will be preseved. We generate it when empty.

Ex. {"color": "red"}.

UserInputType

Code example:

Fields

UserProfileImportType

Code example:

Fields

ID will be stored as external_id, relations will be preseved. We generate it when empty.

Ex. {"color": "red"}.

UserProfileInputType

Code example:

Fields

UserProfileSchemaInputType

Code example:

Fields

Deprecated, use properties.

Deprecated - derived from physical_file_path.

Defines where the file definition will be available after pull; should start with the module name follow by private/public scope, for example manual/public/user_profile_types/my_user_profile.

UserProfileSchemasFilterInput

Code example:

Fields

Filter by metadata properties.

UserProfileSchemasSortInput

Code example:

Fields

UserProfileUpdateType

Code example:

Fields

ID must match existing object id.

Ex. {"color": "red"}.

UserPropertyInput

Code example:

Fields

UsersFilterInput

Code example:

Fields

Join arguments with OR operator.

Deprecated, use related_records; filter by related models.

Filter by related records.

UsersSortInput

Code example:

Fields

UserUpdate

Code example:

Fields

ID must match existing object id.

ValueUploadInput

Represents data for an upload.

Fields

Whether the file will be private or not - default private.

Cache-Control header for the file.

Data for the upload, required unless is url provided.

Content-Disposition header for the file, for example "attachment; filename=foo.bar;".

Content-Type header for the file, for example "text/csv; charset=UTF-8".

Encrypt the content.

Files will be stored in <table name>/<property name>/<file_path>. If you do not provide file_path, then we will use <uuid>/<property_name>. If you override this, BE CAREFUL TO NOT OVERRIDE YOUR OWN FILES AND GENERATE UNIQUE PATH PER RECORD.

Url to external file, which will be downloaded and uploaded to file_path, required unless content is provided. Will take precedence over content argument.

Generate file synchronously.

Type of the upload. If set to image, versions will be automatically fetched based on the property configuration.

VectorDistanceSort

Code example:

Fields

VersionFilterInput

Code example:

Fields

VersionInput

Code example:

Fields

Name of the version, for example thumb.

VersionManipulateInput

Code example:

Fields

Value representing the sigma of the Gaussian mask, where sigma = 1 + radius / 2.

Color for flatten.

Convert to 8-bit greyscale; 256 shades of grey.

VersionOutputInput

Code example:

Fields

Defines the quality of the image; used to automatically compress the image; 0 - lowest quality, 100 - highest quality. Defaults: PNG: 80, WEBP: 80, JPEG: 85.

VersionResizeInput

Code example:

Fields

Background color when using a fit of containDefault: #000000.

Max height of an image. If left undefined, will depend on other parameters to determine size (like: width).

Position to use when fit is cover or contain.

Max width of an image. If left undefined, will depend on other parameters to determine size (like: height).

Do not enlarge if the width or height are already less than the specified dimensions.

VersionSortInput

Code example:

Fields