Skip to main content

Launch Your Embed Live

Before taking your Studio embed live, you should ensure you've double-checked the following:

Settings Config​

  • Ensure your settings JSON is valid using the JSON schema debugger tool
  • Set the developer_mode property in your settings file to false. This will ensure that users' selections are preserved between sessions or refreshes.
  • Ensure you've added the correct embed_url, base_url , and embed_id.
  • Check that all six required appointment booking steps have been added.
  • Be sure to actually test your logic flows for each logic flow type, including the normal, cancel, and reschedule.

Admin Config​

  • Ensure the embed_url is set in the admin > developer tools to allow cancel and reschedule appointment emails to point to the correct web address.
  • Double-check your account_id in you JSON config file is the same as what is listed in your Setster admin page
  • Upgrade your Sester account if your free trial has expired

Data Collection​

Reference the Data Validation Guide to double check that all of the data you want to save is present and structured the way you'd like it to look in your meta data object so that it will be persisted alongside your booked Setster appointments.

Versioning​

Use the settings_version property to force the app to update your embeds when you make updates to your settings.json file after you've launched your embed on a live site.

tip

When you take your embed live the developer_mode flag should be set to false. This ensures user selections will be persisted between sessions or refreshes.

As a general rule of thumb, versioning should be structured as x.y.z starting from 0.1.0

  • x: major release / large changes
  • y: minor release / minor changes / feature
  • z: revision / trivial changes / hotfix or bug fix
{
  "settings_version": "0.1.0",
  "embed_height": {
    "desktop": "550px",
    "tablet": "520px",
    "mobile": "520px"
  },
  "account_id": 12821,
  "enable_link_check": true
}

Everytime you edit the settings_version in your settings JSON file, it will force all Studio embeds to automatically update to the latest version.