Zapier and Simply Studio Business Integration

This document outlines the technical details for building automations using Zapier with Simply Studio business APIs.

What is Zapier and its Benefits?

Zapier is a no-code automation tool that allows users to connect various web applications and services. It achieves this by utilizing APIs (Application Programming Interfaces) to trigger actions in one application based on events happening in another.

Here are some benefits of using Zapier:

  • Increased Efficiency: Automates repetitive tasks, saving you time and effort.
  • Improved Workflows: Streamlines processes across different applications.
  • Enhanced Data Flow: Connects disparate systems and ensures data consistency.
  • Simplified Integrations: No coding required, making automation accessible to non-technical users.

Building Automations with Zapier

To build an automation (called a Zap) in Zapier, follow these steps:

  1. Create a Zapier Account: Sign up for a free Zapier account at https://zapier.com/.
  2. Create a Zap: Click "Create Zap" and choose Simply Studio as the trigger app, or choose one of our templates for a quick start.
  3. Define a Trigger: Select the desired Simply Studio event (e.g., New Member) as the trigger for your Zap.
  4. Create Actions: Define one or more actions to be performed in response to the trigger. These actions can involve other Simply Studio functionalities or integrations with third-party applications offered by Zapier.

Simply Studio API Key

To connect Zapier to your Simply Studio business, you'll need an API Key. This key acts as a secure authentication token for accessing your Simply Studio data through Zapier.

Here's how to find your API Key:

  1. Log in to your Simply Studio business account.
  2. Navigate to Settings.
  3. Click the API Keys button located at the top right corner of the screen.
  4. Copy the Zapier API key.


Simply Studio Triggers and Actions

Zapier offers various triggers and actions specific to Simply Studio business functionalities. Let's explore each trigger and action in detail, including their parameters and response fields:


Triggers:

  • New Member: This trigger fires whenever a new member joins your Simply Studio business.
    • Parameters: None
    • Response Fields:
      • memberId : Unique identifier for the new member.
      • name : Name of the member.
      • email : Email address of the member.
      • phoneNumber  (optional): Phone number of the member.
      • birthDate  (optional): Birth date of the member.
      • gender  (optional): Gender of the member.
  • New Class Booking: This trigger fires when a new class booking is created in your Simply Studio business.
    • Parameters: None
    • Response Fields:
      • bookingId : Unique identifier for the class booking.
      • title : Title of the booked class.
      • instructor : Name of the instructor for the class.
      • startTime : Start time of the class booking (format may vary depending on Simply Studio's API).
      • duration : Duration of the class booking.
      • remoteSessionAdminUrl : (optional) URL for instructors to start a remote session (when Remote is turned on).
      • remoteSessionJoinUrl : (optional) URL for members to join a remote session (when Remote is turned on).
      • maxBookings : Maximum number of participants allowed in the class.
      • comment  (optional): Any comment associated with the booking.
      • bookedMemberIds : List of member IDs who booked the class.
  • New Personal Booking: This trigger fires when a new personal booking is created in your Simply Studio business.
    • Parameters: None
    • Response Fields:
      • bookingId : Unique identifier for the personal booking.
      • title : Title of the personal booking.
      • instructor : Name of the instructor for the booking (if applicable).
      • startTime : Start time of the personal booking (format may vary depending on Simply Studio's API).
      • duration : Duration of the personal booking.
      • remoteSessionAdminUrl : (optional) URL for instructors to start a remote session (when Remote is turned on).
      • remoteSessionJoinUrl : (optional) URL for members to join a remote session (when Remote is turned on).
      • comment  (optional): Any comment associated with the booking.
      • memberId : ID of the member who booked the session.
  • Member State Changed: This trigger fires when a member's state changes in your Simply Studio business. A member state can be one of the following:
      • active  Member has a valid and functioning membership.
      • pending  Membership application/subscription is under review (approval or lead capture).
      • none  Membership is inactive (canceled or rejected).
    • Parameters: None
    • Response Fields:
      • memberId : Unique identifier for the member.
      • name : Name of the member.
      • email : Email address of the member.
      • phoneNumber  (optional): Phone number of the member.
      • gender : Gender of the member.
      • memberState : Current state of the member (active, pending, none).
      • oldMemberState : Previous state of the member (active, pending, none).

Actions:

Create Actions:

  • Book Personal Session: This action allows you to schedule a new personal training session in Simply Studio.
    • Parameters:
      • title : Title of the personal session.
      • instructor  (optional): Name of the instructor for the session (if applicable).
      • startTime : Start time of the session (format may vary depending on Simply Studio's API).
      • memberId : Unique identifier of the member for whom the session is booked.
    • Response Fields:
      • bookingId : Unique identifier for the newly created personal booking.
  • Book Class: This action allows you to book a member into an existing class.
    • Parameters:
      • memberId : Unique identifier of the member to be booked into the class.
      • classBookingId : Unique identifier of the class booking the member should be enrolled in.
    • Response Fields:
      • bookingId : Unique identifier for the newly created class booking for the member (if successful).
  • Create Announcement: This action allows you to create a new announcement within Simply Studio.
    • Parameters:
      • title : Title of the announcement.
      • body : Content of the announcement.
      • expireInDays  (optional): Number of days after which the announcement should expire (set to 0 for no expiration).
    • Response Fields:
      • success : Boolean indicating whether the announcement creation was successful (true/false).
  • Create Member: This action allows you to create a new member in your Simply Studio business.
    • Parameters:
      • name : Name of the new member.
      • email : Email address of the new member.
      • phoneNumber  (optional): Phone number of the new member.
      • birthDate  (optional): Birth date of the new member.
      • gender  (optional): Gender of the new member.
    • Response Fields:
      • memberId : Unique identifier for the newly created member.

Search Actions:

  • Get Member: This action retrieves information about a specific member using their member ID.
    • Parameters:
      • memberId : Unique identifier of the member to retrieve information for.
    • Response Fields:
      • memberId : Unique identifier for the member.
      • name : Name of the member.
      • email : Email address of the member.
      • phoneNumber  (optional): Phone number of the member.
      • birthDate : Birth date of the member.
      • gender : Gender of the member.
      • memberState : Current state of the member (active, pending, none).
  • Find Members: This action searches for members based on specific criteria.
    • Parameters:
      • memberState  (optional): Filter members by their current state.
      • email  (optional): Filter members by their email address.
    • Response Fields:
      • An array containing objects with details for each matching member, including:
        • memberId : Unique identifier for the member.
        • name : Name of the member.
        • email : Email address of the member.
        • phoneNumber  (optional): Phone number of the member.
        • birthDate : Birth date of the member.
        • gender : Gender of the member.
        • memberState : Current state of the member (active, pending, none).
  • Get Personal Booking: This action retrieves information about a specific personal booking using its booking ID.
    • Parameters:
      • bookingId : Unique identifier of the personal booking to retrieve information for.
    • Response Fields:
      • bookingId : Unique identifier for the personal booking.
      • title : Title of the personal booking.
      • instructor : Name of the instructor for the booking (if applicable).
      • startTime : Start time of the personal booking (format may vary depending on Simply Studio's API).
      • duration : Duration of the personal booking.
      • remoteSessionAdminUrl : (optional) URL for instructors to start a remote session (when Remote is turned on).
      • remoteSessionJoinUrl : (optional) URL for members to join a remote session (when Remote is turned on).
      • comment  (optional): Any comment associated with the booking.
      • memberId : ID of the member who booked the session.
  • Get Personal Bookings: This action retrieves a list of personal bookings based on specific criteria.
    • Parameters:
      • memberId  (optional): Filter bookings by the member who booked them.
      • instructor  (optional): Filter bookings by the instructor assigned to them.
    • Response Fields:
      • bookingId : Unique identifier for the personal booking.
      • title : Title of the personal booking.
      • instructor : Name of the instructor for the booking (if applicable).
      • startTime : Start time of the personal booking (format may vary depending on Simply Studio's API).
      • duration : Duration of the personal booking.
      • remoteSessionAdminUrl : (optional) URL for instructors to start a remote session (when Remote is turned on).
      • remoteSessionJoinUrl : (optional) URL for members to join a remote session (when Remote is turned on).
      • comment  (optional): Any comment associated with the booking.
      • memberId : ID of the member who booked the session.
  • Get Class Booking: This action retrieves information about a specific class booking using its booking ID.
    • Parameters:
      • bookingId : Unique identifier of the class booking to retrieve information for.
    • Response Fields:
      • bookingId : Unique identifier for the class booking.
      • title : Title of the booked class.
      • instructor : Name of the instructor for the class.
      • startTime : Start time of the class booking (format may vary depending on Simply Studio's API).
      • duration : Duration of the class booking.
      • remoteSessionAdminUrl : (optional) URL for instructors to start a remote session (when Remote is turned on).
      • remoteSessionJoinUrl : (optional) URL for members to join a remote session (when Remote is turned on).
      • maxBookings : Maximum number of participants allowed in the class.
      • comment  (optional): Any comment associated with the booking.
      • bookedMemberIds : List of member IDs who booked the class.
  • Get Class Bookings: This action retrieves a list of class bookings based on specific criteria.
    • Parameters:
      • memberId  (optional): Filter bookings by the member who booked them.
      • instructor  (optional): Filter bookings by the instructor assigned to them.
    • Response Fields:
      • bookingId : Unique identifier for the class booking.
      • title : Title of the booked class.
      • instructor : Name of the instructor for the class.
      • startTime : Start time of the class booking (format may vary depending on Simply Studio's API).
      • duration : Duration of the class booking.
      • remoteSessionAdminUrl : (optional) URL for instructors to start a remote session (when Remote is turned on).
      • remoteSessionJoinUrl : (optional) URL for members to join a remote session (when Remote is turned on).
      • maxBookings : Maximum number of participants allowed in the class.
      • comment  (optional): Any comment associated with the booking.
      • bookedMemberIds : List of member IDs who booked the class.
  • Find Next Free Class: This action searches for the next available class based on specific criteria.
    • Parameters:
      • title : Title of the class to search for availability.
      • instructor  (optional): Filter by a specific instructor for the class.
      • dayOfWeek  (optional): Specify the day of the week to search for (e.g., "Monday").
      • timeHour  (optional): Specify the hour of the day to search for (in 24-hour format).
      • timeMinute  (optional): Specify the minute of the hour to search for.
    • Response Fields:
      • classBookingId : Unique identifier for the next available class booking matching the criteria (or null if no availability is found).
  • Find Next Free Personal Slot: This action searches for the next available personal training slot based on specific criteria.
    • Parameters:
      • title : Title of the personal training session to search for availability.
      • instructor  (optional): Filter by a specific instructor for the session.
      • dayOfWeek  (optional): Specify the day of the week to search for (e.g., "Monday").
      • timeHour  (optional): Specify the hour of the day to search for (in 24-hour format).
      • timeMinute  (optional): Specify the minute of the hour to search for.
    • Response Fields:
      • startTime : Start time of the next available personal training slot matching the criteria (in the format specified by Simply Studio's API).
      • instructor : Name of the instructor available for the slot (if applicable).
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us