POST

Invoke


Developer Preview

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

This method is used to execute your action.

Wix calls Invoke when an automation using your action is triggered. The request body includes all the data needed to execute the action including the final values of any dynamic parameters.

There's no need to validate the data in the request body against the JSON schema defined when the action was configured. Wix validates the data before calling this method.

Endpoint
POST
{DEPLOYMENT-URI}/v1/invoke
Body Params
actionParamsstructRequired

Data required for executing your action. Structured according to the input schema you provided when configuring the action in your app's dashboard.


actionKeystringRequired

Action key as defined in your app's action configuration in the app dashboard. For example, send-email or generate-invoice.

Response Object
resultstruct

If the action has no output schema, return an empty object. If the action defines an output schema, return a JSON object that correlates to the output schema.

Invoke sent by Wix

Invoke request with a sample response body

Request
cURL
Response
JSON
Did this help?