Staff Step Model

Collect Appointment Info

These are the employees that you've added to your Setster account's business profile. Staff can be assigned to locations and services.

note

We may also refer to staff as employees, staff members, providers, or service providers.

settings.json

{
  "staff_step": {
    "title": "Staff",
    "dialogue_title": "Select a staff member",
    "type": "booking",
    "model": "staff"
  }
}

Default Staff

Using the staff id retrieved from either the Setster Dashboard > Staff or the Setster API, you can set the default_staff property under the settings file.

integer

The individual staff memeber who is being booked for an appointment. Auto-selects a staff member based on the provided staff Id. Allows the user to skip the staff selection step since it's pre-selected. Especially useful for accounts with a single staff member.

1234

settings.json

{
  "steps": {...},
  "flow": {...},
  "default_staff": 1234
}

Schema Overview

model required	string Value: "staff"
type required	string Value: "booking"
layout	string (ListLayout) Value: "list"
style	string (AppState.IListItemsLayout) Enum: "classic" "modern"
dialogue_title	string The dialogue title is the instructions or question text content for a given step.
dialogue_instructions	string
disable_images	boolean Hides images from appointment related lists of options that are pulled from the Setster API automatically.
title	string The title of the step which is the first text content on the top of the step view. The title should describe the current step in a short and concise way.
can_skip	boolean When set to false the step is required to be answered before moving on to the next step. When set to true the user can skip answering the step.
class	string Adds a custom CSS class name to the step to allow for easy CSS selection and modifications at the step level.

{

• "staff_step": {

  • "title": "Staff Step",
  • "dialogue_title": "Step Dialogue Instructions",
  • "type": "booking",
  • "model": "staff"

  }

}

Full Schema

Loading ....

Example

model required	string Value: "staff"
type required	string Value: "booking"
layout	string (ListLayout) Value: "list"
style	string (AppState.IListItemsLayout) Enum: "classic" "modern"
dialogue_title	string The dialogue title is the instructions or question text content for a given step.
dialogue_instructions	string
disable_images	boolean Hides images from appointment related lists of options that are pulled from the Setster API automatically.
title	string The title of the step which is the first text content on the top of the step view. The title should describe the current step in a short and concise way.
can_skip	boolean When set to false the step is required to be answered before moving on to the next step. When set to true the user can skip answering the step.
class	string Adds a custom CSS class name to the step to allow for easy CSS selection and modifications at the step level.

{

• "staff_step": {

  • "title": "Staff Step",
  • "dialogue_title": "Step Dialogue Instructions",
  • "type": "booking",
  • "model": "staff"

  }

}

Related API Endpoint

Setster Studio handles all of the Setster API configurations in the background. For more advanced functionality, see the API.

• Staff Endpoint
• Staff Model