Teachworks icon

Teachworks

Student and Customer operations in Teachworks

Overview

This node allows you to retrieve detailed information about a specific customer from Teachworks by their unique Customer ID. It is useful in scenarios where you need to fetch and process customer data within your n8n workflows, such as for reporting, synchronization with other systems, or personalized communication.

Example use cases:

  • Fetching customer details to enrich CRM records.
  • Validating customer existence before creating related entities (e.g., students, invoices).
  • Automating follow-up emails using retrieved customer information.

Properties

Name Meaning
Customer ID The unique identifier of the customer you want to retrieve from Teachworks.

Output

The output will be a JSON object containing the details of the requested customer. The structure typically includes fields such as name, contact information, and any other attributes associated with the customer in Teachworks.

Example output:

{
  "id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  // ...other customer fields
}

Dependencies

  • External Service: Requires access to the Teachworks API.
  • API Key: You must configure valid Teachworks API credentials in n8n under the credential type teachworksApi.
  • n8n Configuration: No additional configuration required beyond setting up the credentials.

Troubleshooting

  • Invalid Customer ID: If the provided Customer ID does not exist, the node may return an error or an empty result. Double-check the ID value.
  • Authentication Errors: If credentials are missing or incorrect, you may see errors related to authentication (e.g., "401 Unauthorized"). Ensure your Teachworks API key is correctly configured in n8n.
  • Network Issues: Connectivity problems between n8n and Teachworks can cause timeouts or connection errors.

Links and References

Discussion