Updating and versioning triggers and actions

If the change that you want to make is a breaking change, then you should create a new trigger or action and hide the old one. Otherwise, you can make changes directly to your existing trigger or action.

Breaking changes

The following changes will affect your customers' workflows:

Change Description
Renaming or deleting a field

Triggers: Workflows that uses the trigger will fail.

Actions: Workflows that use the action will run, but the action will fail.

Changing an action field from optional to required or adding a new required action field

Actions: Workflows that use the action will run, but the action will fail.

Disabling or deleting a trigger or action

Triggers: workflows that use the trigger will fail.

Actions: Workflows that use the action will run, but the action will fail.

Non-breaking changes

You can make the following changes to a trigger or action and save it without affecting your customers' workflows:

  • Change a trigger or action title or description.
  • Change the URL that Shopify Flow uses to send the contents of the action to your app.
  • Change an action's label or help text.
  • Change an action's required field to optional.

Update a connector to avoid breaking changes

Before you introduce a breaking change to your trigger or action, follow these instructions to avoid disrupting your customers' workflows.

Steps

  1. Hide the old trigger or action by changing its status. Hiding a trigger or action makes it unavailable to new workflows, but existing workflows can continue to use it. To hide a trigger or action, open it and then click Change status.
  2. If your trigger or action is used in a workflow template, then notify flow-connectors-dev@shopify.com about the change.
  3. Create a new trigger or action.
  4. Notify your existing customers and help them migrate to the new trigger or action.
  5. After your customers have stopped using the old trigger or action, you can disable and then delete it. 

Sign up for a Partner account to get started.

Sign up