POST

Invoke Tool


Developer Preview

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

Runs a tool of an app installed on the site in context and returns the app's response.

Wix passes payload to the app's Tools Provider service plugin as is, without checking it against the tool's requestSchema, and returns whatever the app returns in response. Build the payload from the schema returned by List Tools Providers. The call fails when the app isn't installed on the site, when the app doesn't declare an activated tool with this methodName, or when the site owner disabled the app's tools or this tool.

Authentication

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

Permission Scopes
Invoke App Tools
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/_api/tools-host/v1/invoke-tool

Errors
404Not Found

There is 1 error with this status code.

428Failed Precondition

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?