WebUntis icon

WebUntis

Gathers WebUntis data

Actions5

Overview

This node integrates with the WebUntis API to retrieve data related to school scheduling and resources. Specifically, for the Teachers - Get Many operation, it fetches a list of all teachers associated with a specified school in the WebUntis system.

Common scenarios where this node is beneficial include:

  • Automatically importing or synchronizing teacher lists from WebUntis into other systems.
  • Generating reports or dashboards that require up-to-date teacher information.
  • Using teacher data as part of broader automation workflows involving school timetables or resource management.

For example, a school administrator could use this node to pull the current roster of teachers each morning and update their internal database or notify staff about schedule changes.

Properties

Name Meaning
School Name The name of the school in the WebUntis notation format. This identifies which school's data to retrieve.
Base URL The base URL of the WebUntis instance to connect to (e.g., https://school.webuntis.com).

Output

The node outputs an array of JSON objects, each containing the list of teachers retrieved from the WebUntis API under the json property. The structure is:

{
  "json": [
    {
      "id": number,
      "name": string,
      "longName": string,
      "foreName": string,
      "email": string,
      "phone": string,
      ...
    },
    ...
  ]
}

(Note: The exact fields depend on the WebUntis API response but typically include identifiers, names, and contact details.)

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the WebUntis API, including username and password.
  • Needs network access to the specified WebUntis instance via the provided Base URL.
  • Relies on the external moment-timezone library for date formatting internally.
  • Uses helper functions from an internal Untis library to handle API requests and session management.

Troubleshooting

  • Authentication errors: If the node throws an error related to authentication, verify that the provided API credentials (username and password) are correct and have sufficient permissions.
  • Invalid school name: Ensure the "School Name" matches exactly the notation used in your WebUntis instance; otherwise, the API may return no data or an error.
  • Network issues: Confirm that the Base URL is reachable from the n8n environment and that there are no firewall or proxy restrictions blocking access.
  • API errors: The node wraps API errors with the message prefix WebUntis API Error:. Check the underlying error message for details such as rate limits or malformed requests.
  • Empty results: If the output is empty, verify that the school has teachers registered in WebUntis and that the API user has access rights to view them.

Links and References

Discussion