install.json

{
  "resources": {
    "body": [
      {
        "type": "style",
        "src": "./build/app.css"
      },
      {
        "type": "script",
        "src": "./build/app.js"
      }
    ]
  },
  "preview": {
    "handlers": [
      {
        "options": ["color"],
        "execute": "INSTALL_SCOPE.setColor(INSTALL_OPTIONS)"
      },
      {
        "options": ["_default"],
        "execute": "INSTALL_SCOPE.setOptions(INSTALL_OPTIONS)"
      },
      {
        "options": ["_product"],
        "execute": "INSTALL_SCOPE.setProduct(INSTALL_PRODUCT)"
      }
    ]
  },
  "options": {
    "properties": {
      "goal": {
        "order": 1,
        "title": "What’s the goal you’re trying to achieve?",
        "type": "string",
        "format": "radios",
        "enum": [
          "announcement",
          "cta",
          "signup"
        ],
        "enumNames": {
          "signup": "Gather emails to sign visitors up for your newsletter",
          "cta": "Redirect them to a special page",
          "announcement": "Just show a message"
        },
        "products": {
          "signup": ["pro"]
        },
        "default": "announcement"
      },

      "ctaTitle": {
        "order": 2,
        "showIf": {
          "goal": "cta"
        },
        "title": "Message title",
        "type": "string",
        "default": "New products!"
      },

      "ctaText": {
        "order": 3,
        "showIf": {
          "goal": "cta"
        },
        "title": "Message text",
        "format": "textarea",
        "type": "string",
        "default": "We just launched an amazing new product."
      },

      "ctaButtonText": {
        "order": 4,
        "showIf": {
          "goal": "cta"
        },
        "title": "Button text",
        "type": "string",
        "default": "Check it out"
      },

      "ctaLinkAddress": {
        "order": 5,
        "showIf": {
          "goal": "cta"
        },
        "title": "URL to drive traffic to",
        "type": "string",
        "format": "url"
      },

      "signupDestination": {
        "order": 6,
        "default": "email",
        "title": "What should we do with the emails we collect?",
        "type": "string",
        "format": "radios",
        "showIf": {
          "goal": "signup"
        },
        "enum": [
          "email",
          "service"
        ],
        "enumNames": {
          "email": "Send me an email with the collected email address.<span class=\"help-text\"><small>Powered by <a href=\"https://formspree.io\" target=\"_blank\" class=\"with-inherited-color\"><strong>Formspree</strong></a></small></span>",
          "service": "Add them as contacts to the mailing list service of my choice.<span class=\"help-text\"><small>Currently, <a href=\"https://www.constantcontact.com\" target=\"_blank\" class=\"with-inherited-color\"><strong>Constant Contact</strong></a> and <a href=\"https://mailchimp.com\" target=\"_blank\" class=\"with-inherited-color\"><strong>Mailchimp</strong></a> are supported.</small></span>"
        }
      },

      "email": {
        "order": 7,
        "showIf": {
          "goal": "signup",
          "signupDestination": "email"
        },
        "title": "What email address should signups be sent to?",
        "required": true,
        "format": "email",
        "type": "string"
      },

      "account": {
        "order": 8,
        "title": "Mailing list service",
        "description": "Select the mailing list service which you would like to send subscriptions to.",
        "type": "object",
        "format": "account",
        "services": ["mailchimp", "constant-contact"],
        "showIf": {
          "goal": "signup",
          "signupDestination": "service"
        }
      },

      "list": {
        "order": 9,
        "title": "List",
        "description": "Select the list in your account which email submissions should be added to.",
        "type": "string",
        "default": "",
        "enum": [""],
        "enumNames": {
          "": "Loading lists..."
        },
        "showIf": {
          "goal": "signup",
          "signupDestination": "service",
          "account.service": {
            "op": "!=",
            "value": null
          }
        }
      },

      "signupTitle": {
        "order": 10,
        "showIf": {
          "goal": "signup"
        },
        "title": "Message title",
        "type": "string",
        "default": "Sign up for our newsletter"
      },

      "signupText": {
        "order": 11,
        "showIf": {
          "goal": "signup"
        },
        "title": "Message text",
        "format": "textarea",
        "type": "string",
        "default": "Join our mailing list to be the first to know what we’re up to."
      },

      "signupInputPlaceholder": {
        "order": 12,
        "showIf": {
          "goal": "signup"
        },
        "title": "Input placeholder text",
        "type": "string",
        "default": "Email address"
      },

      "signupButtonText": {
        "order": 13,
        "showIf": {
          "goal": "signup"
        },
        "title": "Button text",
        "type": "string",
        "default": "Sign up"
      },

      "signupSuccessTitle": {
        "order": 14,
        "showIf": {
          "goal": "signup"
        },
        "title": "Thank you title",
        "description": "This title will display after visitors enter their email.",
        "type": "string",
        "default": "Thanks for signing up!"
      },

      "signupSuccessText": {
        "order": 15,
        "showIf": {
          "goal": "signup"
        },
        "title": "Thank you text",
        "description": "This text will display after visitors enter their email.",
        "type": "string",
        "default": "You’ll be kept up to date with our newsletter."
      },

      "announcementTitle": {
        "order": 16,
        "showIf": {
          "goal": "announcement"
        },
        "title": "Message title",
        "type": "string",
        "default": "Announcement"
      },

      "announcementText": {
        "order": 17,
        "showIf": {
          "goal": "announcement"
        },
        "title": "Message text",
        "format": "textarea",
        "type": "string",
        "default": "Sale! Everything is 75% off this entire week."
      },

      "announcementButtonText": {
        "order": 18,
        "showIf": {
          "goal": "announcement"
        },
        "title": "Button text",
        "type": "string",
        "default": "Got it"
      },

      "color": {
        "order": 19,
        "title": "Accent color",
        "type": "string",
        "format": "color",
        "default": "#0099ff"
      },

      "position": {
        "title": "Position",
        "description": "Which part of the page should the box appear?",
        "type": "string",
        "order": 20,
        "format": "radios",
        "default": "right bottom",
        "enum": [
          "left top",
          "right top",
          "left bottom",
          "right bottom"
        ],
        "enumNames": {
          "left top": "Top left",
          "right top": "Top right",
          "left bottom": "Bottom left",
          "right bottom": "Bottom right"
        },
        "products": {
          "left top": ["pro"],
          "right top": ["pro"],
          "left bottom": ["pro"],
          "right bottom": ["pro"]
        }
      },

      "delay": {
        "order": 21,
        "title": "Delay",
        "description": "When should the box appear?",
        "type": "string",
        "format": "radios",
        "default": "0",
        "enum": [
          "0",
          "1500",
          "60000"
        ],
        "enumNames": {
          "0": "Immediately",
          "1500": "After a few seconds",
          "60000": "1 minute"
        },
        "products": {
          "0": ["pro"],
          "1500": ["pro"],
          "60000": ["pro"]
        }
      },

      "showStrategy": {
        "order": 22,
        "title": "How often should the Lead Box appear?",
        "type": "string",
        "format": "radios",
        "enum": [
          "always",
          "once"
        ],
        "enumNames": {
          "always": "Until a visitor interacts with it",
          "once": "Just once"
        },
        "default": "always"
      }
    }
  },
  "hooks": [
    {
      "endpoint": "https://provisioner.appstore.cfdata.org/{{install.options.account.service}}/hook",
      "events": ["option-change:account", "preview"],
      "block": true,
      "if": "install.options.signupDestination == 'service' && install.options.account && install.options.account.service",
      "authenticate": ["account"],
      "failure": {
        "action": "notify",
        "message": "There was an error communicating with the mail service."
      }
    },
    {
      "endpoint": "https://provisioner.appstore.cfdata.org/constant-contact/hook",
      "events": ["option-change:list"],
      "block": true,
      "if": "install.options.signupDestination == 'service' && install.options.account && install.options.account.service == 'constant-contact'",
      "authenticate": ["account"],
      "failure": {
        "action": "notify",
        "message": "There was an error communicating with Constant Contact."
      }
    },
    {
      "events": ["account-logout"],
      "action": "reset-schema"
    }
  ]
}