We're software that helps growing brands & retailers grow and scale. Sync, sell and ship your products and inventory on online marketplaces and storefronts faster, easier and more accurately.

Learn more now

Understanding JSON for Automation Configurations

SureDone automation configurations are stored as JSON. In practice, JSON is just a structured way to describe the settings your automation needs.

Where JSON Shows Up in the Current UI

For custom automations, the real configuration work happens on the Advanced tab after the automation has been created.

Note: The current Advanced tab is a tree editor for JSON. It is not a freeform raw-text code editor. You expand the object, add keys, edit values, and save the updated JSON structure.

What a New Custom Automation Looks Like

When you first create a custom automation, the wizard only collects the basic metadata. The initial JSON is a small shell similar to this:

{
  "vendor": "Northwind Supply",
  "slug": "northwind-supply-northwind-partner-catalog-export",
  "name": "Northwind Partner Catalog Export",
  "draft": true,
  "disable_all": false,
  "schedule": "0 0 * * 0",
  "type": "products",
  "action": "export",
  "description": "Exports in-stock products to Northwind's SFTP server each morning.",
  "disclaimer": "0",
  "beta": "0"
}

At that point, you still need to add the real automation sections yourself, such as connection, file_configs, and optional parameters.

Important JSON Value Types

  • Strings - text values like names, paths, hostnames, and schedules
  • Numbers - values like ports or numeric settings
  • Booleans - true or false
  • Objects - grouped settings inside braces { }
  • Arrays - ordered lists inside brackets [ ]
  • null - an intentionally empty value

Example: Adding a Connection and File Config

{
  "schedule": "0 8 * * *",
  "connection": {
    "type": "sftp",
    "address": "sftp.northwind.example",
    "username": "feed_user",
    "password": "secret",
    "port": 22,
    "path": "/incoming/catalog"
  },
  "file_configs": [
    {
      "name": "product-catalog.csv",
      "search": "stock:>0",
      "field_map": {
        "guid": "SKU",
        "title": "ProductName",
        "price": "RetailPrice"
      }
    }
  ]
}

What Is Actually Required?

JSON itself does not make a key required or optional. The automation validator does.

Important: For export automations, connection is not something you can simply omit forever. A brand-new draft automation may start without it, but a working export automation needs a valid connection before it can be fully validated and used as a real export.

Common Mistakes

  • Using single quotes instead of double quotes
  • Putting booleans in quotes, such as "true" instead of true
  • Forgetting commas between keys
  • Assuming the custom automation wizard created connection or file_configs for you when it did not

What to Read Next