Welcome and end pages

A form can open with a welcome page and always closes with an end page. They are kept apart from the questions, in welcome_pages and end_pages.

Page object

Both kinds of page have the same outer shape.

Key	Type	Description
`ref`	string	Identifier of the page. Logic rules and quotas point at an end page by it.
`title`	string	Heading. Supports text formatting and inserted values.
`properties`	object	Options of the page. They differ for welcome and end pages.
`media`	object or `false`	Image or video above the title. See Media.

Welcome page

welcome_pages holds no page or one page. Without a welcome page the form starts on the first question.

Properties

Key	Type	Default	Description
`description`	string	`""`	Introduction. Text under the title.
`button_text`	string	`"Start"`	Label of the start button, up to 30 characters in the editor. When empty, the form uses its `start` message.
`align`	string	`"center"`	Text alignment: `left`, `center` or `right`.
`time_to_complete`	boolean	not set	Time to complete. Shows an estimate such as “Takes 2 minutes”. The form works the estimate out from its questions.

Example

{
  "ref": "7e2b9c14-5d3a-4f86-a1c7-0b4d6e8f2a59",
  "title": "Tell us about your order",
  "properties": {
    "description": "Five short questions.",
    "button_text": "Start",
    "align": "center",
    "time_to_complete": true
  },
  "media": false
}

A form protected with a password asks for it on the welcome page. When such a form has no welcome page, one is shown with the form name as its title.

End pages

end_pages holds one page or more. The first one is the default: a respondent who finishes the form sees it unless a logic rule or a quota sends them to another end page by its ref.

Properties

Key	Type	Default	Description	Plan
`description`	string	`""`	Text under the title.	Essential
`align`	string	`"center"`	Text alignment: `left`, `center` or `right`.
`show_button`	boolean	`false`	Add redirect button. Shows a button that opens `button_url`. The button appears only when it has a label and an address.	Professional
`button_label`	string	`""`	Text of the button.	Professional
`button_url`	string	`""`	Address the button opens. Accepts inserted values.	Professional
`automatic_redirect`	boolean	`false`	Automatic redirect. Sends the respondent to another address after the response is saved.	Professional
`automatic_redirect_url`	string	not set	Address of the redirect. Accepts inserted values. The respondent is sent there three seconds after the end page appears.	Professional

Addresses have to start with http:// or https://. An address without a scheme gets http:// in front.

Inserted values make it possible to pass data of the response on to your own page:

{
  "ref": "c41d7a90-2e6b-4b35-9f08-6a1c3e5d7b92",
  "title": "Thank you, {{hidden:first_name}}!",
  "properties": {
    "description": "Your score: **{{variable:score}}**",
    "align": "center",
    "show_button": true,
    "button_label": "Back to the shop",
    "button_url": "https://example.com/thanks?response={{response:id}}",
    "automatic_redirect": false
  },
  "media": false
}

Plans

Plan	End page
Basic (free)	One end page with a fixed text and a Responsly note. The title, description and media of the stored page are not shown, and links are removed.
Essential	Own title, description and media. More than one end page.
Professional and higher	Also the redirect button and the automatic redirect.

Media

media holds the image or video of a question, a welcome page or an end page. A page or question without media stores false.

Key	Type	Default	Description
`type`	string		`image` or `video`.
`url`	string		For an image: the file name returned by the image upload in the editor. For a video: a YouTube embed address, `https://www.youtube.com/embed/<video id>`.
`height`	number	`300`	Height of the media box in pixels on a wide screen. It is scaled down on narrow screens.
`scale`	number	`1`	Zoom of the image inside the box, from 0.2 to 5.
`pos_x`, `pos_y`	number	`0`	Offset of the image inside the box, in pixels.
`frame`	boolean	`false`	Draws a framed background around the box.

{
  "type": "image",
  "url": "5f3a9c2e7b.png",
  "height": 300,
  "scale": 1,
  "pos_x": 0,
  "pos_y": 0,
  "frame": false
}

Limits:

Images: JPG, PNG or GIF, up to 2 MB.
Videos: YouTube only. There is no video upload.
The image of a picture-choice option uses the same object, without height.