POST

Query Triggers


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of triggers, given the provided paging, filtering, and sorting.

Query Triggers searches the entire trigger catalog, regardless of which apps are installed on a site. To retrieve only the triggers available on a specific site, call Resolve Triggers instead. To query all triggers provided by a particular app, specify the app's ID in the query's filter. Query Triggers returns the latest version of each matching trigger.

Query Triggers runs with these defaults, which you can override:

  • createdDate is sorted in DESC order.
  • paging.limit is 50.
  • paging.offset is 0.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

PropertyFiltersSort
id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
appId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
triggerKey$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
displayName$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
source.type$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
metadata.hidden$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
implementedMethods.validateConfiguration$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
implementedMethods.getDynamicSchema$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
implementedMethods.refreshPayload$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Set Up Automations
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/v1/triggers/query

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?