Upscribe Object

Example

{
  "upscribe": {
    "uuid": "upscribe_ef8cb8124e99",
    "active": true,
    "auto_pilot": true,
    "after_submission_behaviour": "redirect",
    "redirect_url": "https://mywebsite.com/thank-you",
    "visibility_rules": [
      "https://mywebsite.com/",
      "https://mywebsite.com/blog/*",
    ],
    "after_submission_rules": [
      {
        "behaviour": "close_widget",
        "current_url": "https://mywebsite.com/",
        "redirect_url": null
      },
      {
        "behaviour": "redirect",
        "current_url": "https://mywebsite.com/blog/*",
        "redirect_url": "https://mywebsite.com/thank-you",
      }
    ]
  }
}
Property
Type
Description

uuid

string

Upscribe's UUID

active

boolean

Whether the upscribe is active or not

auto_pilot

boolean

Whether the Upscribe has the auto-pilot feature enabled or not.

after_submission_behaviour

string

The behaviour of Upscribe after it's submitted. Can be either "redirect" or "hide_widget"

redirect_url

string

The default redirect URL (only present if after_submission_behaviour is "redirect")

visibility_rules

array

Array of strings. Each string is a a URL where Upscribe can be shown. Empty array if Upscribe is set to be visible on all pages

after_submission_rules

array

Array of object. Each object represent a after_submission_rule.

Last updated