TeachWorks - Apps Documentation

Requirements

Connecting TeachWorks takes an active account plus an API access token from your account settings — no other setup is required.[3]

Get your TeachWorks credentials

API KeypasswordRequired
You can generate your API Key using the following instuction.).
[1]

Connect TeachWorks in WEXTL

Log in to your WEXTL account, add the TeachWorks node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your TeachWorks account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

TeachWorks node modules

The list below is a reference of every TeachWorks node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Expand any TeachWorks node module below to see exactly what it takes in, what it returns, and what connection it needs.

Watch CustomersTrigger

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	email
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
ZIP	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

13other output fields

Watch New InvoicesTrigger

Output fields[3]

Field	Type
ID	number
Customer ID	number
Customer First Name	text
Customer Last Name	text
Invoice Type	text
Number	number
Date	text
Due Date	text
Reference	text
Tax Treatment	text
Status	text
Start Date	text
End Date	text
Lesson Status	text
Terms Text	text
Subtotal	text
Sales Tax Total	text
Total	text
Hide Flags	boolean
Sent at	date

6other output fields

Watch New LessonsTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Series ID	text
Location Name	text
Location ID	number
Employee Name	text
Employee ID	number
Service Name	text
Service ID	number
Spaces	text
Joinable	boolean
From Date	text
From Time	text
To Date	text
To Time	text
Time Zone	text
From Datetime	text
To Datetime	text
Duration Minutes	number

19other output fields

Watch New StudentsTrigger

Output fields[3]

Field	Type
ID	number
Customer ID	number
Student Type	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Birth Date	text
Start Date	text
School	text
Grade	text
Additional Notes	text
Calendar Color	text
Default Location ID	number
Subjects	text
Status	text
Time Zone	text
Billing Method	text

14other output fields

Watch PaymentsTrigger

Output fields[3]

Field	Type
ID	number
Customer ID	number
Customer First Name	text
Customer Last Name	text
Date	text
Description	text
Amount	text
Type	text
Payment Method	text
Stripe Transaction ID	text
Sent At	date
Created At	date
Updated At	date
Refunds	array
Payment Allocations	array

Get a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	email
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
ZIP	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

13other output fields

Get a StudentAction

Input fields[3]

Field	Type
Student IDRequired	choice

Output fields[3]

Field	Type
ID	number
Customer ID	number
Student Type	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Birth Date	text
Start Date	text
School	text
Grade	text
Additional Notes	text
Calendar Color	text
Default Location ID	number
Subjects	text
Status	text
Time Zone	text
Billing Method	text

14other output fields

Get an EmployeeAction

Input fields[3]

Field	Type
Employee IDRequired	choice

Output fields[3]

Field	Type
ID	number
Customer ID	number
Student Type	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Birth Date	text
Start Date	text
School	text
Grade	text
Additional Notes	text
Calendar Color	text
Default Location ID	number
Subjects	text
Status	text
Time Zone	text
Billing Method	text

14other output fields

Search CustomersSearch

Input fields[3]

Field	Type
First Name	text
Last Name	text
Email	email
Phone Number	text
City	text
State	text
Zip Code	text
Country	text
Type	choice
Status	choice
ID Greater Than	number
ID Less Than	number
ID Greater Than or Equal To	number
ID Less Than or Equal To	number
Direction	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	email
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
ZIP	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

13other output fields

Search EmployeesSearch

Input fields[3]

Field	Type
First Name	text
Last Name	text
Email	email
City	text
State	text
Zip	text
Status	choice
Subject	text
ID Greater Than	number
ID Less Than	number
ID Greater Than or Equal To	number
ID Less Than or Equal To	number
Direction	choice

Output fields[3]

Field	Type
ID	number
Customer ID	number
Student Type	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Birth Date	text
Start Date	text
School	text
Grade	text
Additional Notes	text
Calendar Color	text
Default Location ID	number
Subjects	text
Status	text
Time Zone	text
Billing Method	text

14other output fields

Search StudentsSearch

Input fields[3]

Field	Type
Customer ID	choice
First Name	text
Last Name	text
Email	email
Phone Number	text
School	text
Grade	text
Subject	text
Customer Type	choice
Status	choice
ID Greater Than	number
ID Less Than	number
ID Equal or Greater Than	number
ID Equal or Less Than	number
Sort Direction	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Customer ID	number
Student Type	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Birth Date	text
Start Date	text
School	text
Grade	text
Additional Notes	text
Calendar Color	text
Default Location ID	number
Subjects	text
Status	text
Time Zone	text
Billing Method	text

14other output fields

Add a Student to a LessonAction

Input fields[3]

Field	Type
Lesson IDRequired	choice
Student IDRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Series ID	text
Location Name	text
Location ID	number
Employee Name	text
Employee ID	number
Service Name	text
Service ID	number
Spaces	text
Joinable	boolean
From Date	text
From Time	text
To Date	text
To Time	text
Time Zone	text
From Datetime	text
To Datetime	text
Duration Minutes	number

19other output fields

Create a FamilyAction

Input fields[3]

Field	Type
First NameRequired	text
Last NameRequired	text
Salutation	choice
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address Line 2	text
City	text
State/Province	text
Zip/Postal Code	text
Country	text
Additional Notes	text
Status	choice
Email Lesson Reminders	boolean
Email Lesson Notes	boolean
SMS Lesson Reminders	boolean
Stripe ID	text

1other input field

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	email
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
Zip	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

11other output fields

Create a Family StudentAction

Input fields[3]

Field	Type
First NameRequired	text
Last NameRequired	text
Customer IDRequired	choice
Email	email
Home Phone	text
Mobile Phone	text
Additional Notes	text
Status	choice
School	text
Grade	text
Calendar Color	text
Birth Date	date
Start Date	date
Billing Method	choice
Student Cost	number
Cost Premium ID	text
Discount Rate	number
Email Lesson Reminders	boolean
Email Lesson Notes	boolean
SMS Lesson Reminders	boolean

6other input fields

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
Zip	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

13other output fields

Create a LessonAction

Input fields[3]

Field	Type
Lesson NameRequired	text
Description	text
Teacher IDRequired	choice
Student IDsRequired	choice
Service IDRequired	choice
Location IDRequired	choice
Start DateRequired	date
Start TimeRequired	time
End DateRequired	date
End TimeRequired	time
Spaces	number
Override Cost Calculation	boolean
Override Method	choice

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Series ID	text
Location Name	text
Location ID	number
Employee Name	text
Employee ID	number
Service Name	text
Service ID	number
Spaces	text
Joinable	boolean
From Date	text
From Time	text
To Date	text
To Time	text
Time Zone	text
From Datetime	text
To Datetime	text
Duration Minutes	number

19other output fields

Create an EmployeeAction

Input fields[3]

Field	Type
First NameRequired	text
Last NameRequired	text
Employee TypeRequired	choice
Include as Teacher	boolean
Status	choice
Email	email
Mobile Phone	text
Home Phone	text
Address	text
Address Line 2	text
City	text
State or Province	text
Zip or Postal Code	text
Country	text
Additional Notes	text
Birth Date	date
Hire Date	date
Position	text
Biographical Details	text
Wage Type	choice

40other input fields

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Employee Type	text
Include As Teacher	text
Status	text
Email	text
Mobile Phone	text
Home Phone	text
Address	text
Address 2	text
City	text
State	text
Zip	text
Country	text
Time Zone	text
Additional Notes	text
Birth Date	text
Hire Date	text
Position	text

43other output fields

Create an Independent StudentAction

Input fields[3]

Field	Type
First NameRequired	text
Last NameRequired	text
Salutation	choice
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address Line 2	text
City	text
State	text
ZIP Code	text
Country	text
Additional Notes	text
Status	choice
Stripe ID	text
Unviewed	boolean
Students Attributes	array

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
Zip	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

13other output fields

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Update a Family StudentAction

Input fields[3]

Field	Type
Student IDRequired	choice
First Name	text
Last Name	text
Customer ID	choice
Email	email
Home Phone	text
Mobile Phone	text
Additional Notes	text
Status	choice
School	text
Grade	text
Calendar Color	text
Birth Date	date
Start Date	date
Billing Method	choice
Student Cost	number
Cost Premium ID	text
Discount Rate	number
Email Lesson Reminders	boolean
Email Lesson Notes	boolean

7other input fields

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
Zip	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

13other output fields

Update an EmployeeAction

Input fields[3]

Field	Type
Employee IDRequired	choice
First Name	text
Last Name	text
Employee Type	choice
Include as Teacher	boolean
Status	choice
Email	email
Mobile Phone	text
Home Phone	text
Address	text
Address Line 2	text
City	text
State or Province	text
Zip or Postal Code	text
Country	text
Additional Notes	text
Birth Date	date
Hire Date	date
Position	text
Biographical Details	text

41other input fields

Output fields[3]

Field	Type
ID	number
First Name	text
Last Name	text
Employee Type	text
Include As Teacher	text
Status	text
Email	text
Mobile Phone	text
Home Phone	text
Address	text
Address 2	text
City	text
State	text
Zip	text
Country	text
Time Zone	text
Additional Notes	text
Birth Date	text
Hire Date	text
Position	text

43other output fields

Update an Independent StudentAction

Input fields[3]

Field	Type
Independent Student / Customer IDRequired	choice
First Name	text
Last Name	text
Salutation	choice
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address Line 2	text
City	text
State	text
ZIP Code	text
Country	text
Additional Notes	text
Status	choice
Stripe ID	text
Unviewed	boolean
Students Attributes	array

Output fields[3]

Field	Type
ID	number
Customer Type	text
Salutation	text
First Name	text
Last Name	text
Email	email
Additional Email	text
Home Phone	text
Mobile Phone	text
Work Phone	text
Address	text
Address 2	text
City	text
State	text
Zip	text
Country	text
Additional Notes	text
Status	text
Time Zone	text
Email Lesson Reminders	number

13other output fields

Update Customer Custom FieldsAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Custom FieldsRequired	array

Update Student Custom FieldsAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Custom FieldsRequired	array

Templates

Look for TeachWorks templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Support category →

References

WEXTL® TeachWorks Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for TeachWorks.
WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:13

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.