POST

Run Automation


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 an automation directly, without reporting an event.

it can only be called by apps

Use this to activate an automation manually when no triggering event occurs in your system. For example, an automation that sends a confirmation when a customer books online won't run if the customer books by phone instead. Run Automation lets the site owner send that confirmation anyway.

Identify the automation to run in one of these ways:

  • automationIdentifier: The ID of an existing automation. Retrieve it from the Automations API.
  • preinstalledIdentifier: The app ID and component ID of a preinstalled automation.

To run an automation in test mode, including unpublished draft automations, call Test Automation.

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/automations/esbConfigResolver/v1/events/run-automation

Errors

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

Did this help?