Installing Shopware 5 Event Sync

1. Installing the Shopware 5 Event Sync App

1. 1. Use this link to open the app in the Zendesk marketplace.
   2. Click the Install button on the right.
   3. Choose the Zendesk instance for the installation.
   4. Follow the redirection to your Zendesk Admin space (ensure you have admin rights).
   5. Optionally, rename the app (default: "Shopware 5 Event Sync by Knots") and set role or group restrictions.
   6. Click Install to complete.

2. Accessing the App

1. Go to your agent workspace by clicking the four squares icon at the top-right, then select Support.
2. In the Support workspace, click the Shopware 5 Event Sync by Knots icon  on the left.
   Note: If you have numerous apps installed, it might be hidden under the three dots at the lower left part of your screen. Click on this icon to proceed.
   

3. Creating a Knots Account

• On the Settings page, go to "Login" to create a new account or log in if you are already a Knots customer.
  

4. Setting Up The Trigger

1. Give your trigger a descriptive name. Make sure it’s something easy to identify, like "Shopware 5 Order Sync". 

2. In the "Add a tag on triggering" field, either create a new tag or use an existing one. This tag helps manage and track when the sync process is initiated. It’s important to add this tag to avoid trigger loops. For example, use something like "shopware_order_sync_triggered" to show that the sync has started.

3. Click on the blue button labeled Create Knots user to either create an account or log in.
   
   Once logged in, make sure you have set up the connector to your Shopware 5 API via the Knots Platform.
   Note: Without logging into Knots and setting up the connector, you won't be able to proceed with the integration.
   

4. Select the API Object you want to sync with Zendesk from the dropdown menu. You can change this depending on what data you need to synchronize (e.g., Customers, Products, etc.).
   

5. Select the Zendesk field that contains the Shopware 5 object’s ID, such as the "OrderID". This field is essential for linking Shopware 5 records to Zendesk.
   

6. Specify the source property from the Shopware 5 API response that you want to sync. Then, select the destination field in Zendesk where the data should be stored. 
   For example:

   • Save "Tags" from Shopify directly into the Zendesk "Tags" ticket field.
   • For "Total Price", create a custom "Price" field to store the value.

    Note: Both fields are required to complete the data mapping.
   
   

   If you want to sync additional data (for example, syncing both "Order ID" and "Order Status"), click Add data lookup to map more fields from Shopware 5 to Zendesk.

5. Optional: Utilizing Advanced Mode for Enhanced Experience

If you need more control over the configuration, toggle Advanced Mode to unlock additional customization options. Each field has a helpful tooltip—hover over the little "i" icons next to the fields for more detailed explanations.

6. Finalizing the Setup

• Once everything is configured, click Save Configuration to save your settings without activating the trigger yet. If you’re ready to go live, click Save and Activate to enable the trigger and start syncing data.

For more information about the app visit Shopware 5 Event Sync. 

If you have any questions or suggestions regarding this app, please reach out to us at support@knots.io or through our contact form.