POST

Invoke


This endpoint is used to invoke an action provider's action.

Wix calls this endpoint when an automation using the provider's action is triggered. The request body includes all the data needed to execute the action including the final values of any dynamic parameters.

There is 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 endpoint.

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

Data 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
curl -X POST https://provider.example.com/v1/invoke \ -H 'user-agent: Wix' \ -H 'accept-encoding: gzip, deflate' \ -H 'content-type: text/plain; charset=utf-8' \ -d '{ "actionParams": { "to": "my@email.com", "subject": "Your registration to 2022 Event is Confirmed", "body": "Hi Jane, you are confirmed for the event" }, "actionKey": "email-client" }'
Response
JSON
{ "result": {} }
Did this help?