Eskom icon

Eskom

Consume Eskom API (v.0.1.2)

Overview

The Eskom node for n8n allows users to interact with the Eskom API, specifically providing a "Status" operation under the "Default" resource. This operation is typically used to retrieve the current status information from Eskom, such as load shedding stages or power availability. Common scenarios include monitoring Eskom's service status and integrating this data into automated workflows for alerting, reporting, or dashboard updates.

Practical examples:

  • Automatically notify users when Eskom's load shedding status changes.
  • Log Eskom status updates to a database for historical analysis.
  • Trigger other workflow actions based on Eskom's current operational state.

Properties

Name Type Meaning
Simplify Boolean If enabled, the output will be simplified for easier consumption in downstream nodes.

Output

  • The node outputs a json field containing the status information retrieved from the Eskom API.
  • The structure of the output depends on the "Simplify" property:
    • If Simplify is enabled, the output will contain only the most relevant fields in a flattened format.
    • If Simplify is disabled, the output will include the full, raw response from the Eskom API, which may be more complex and nested.

Note: The node does not output binary data.

Dependencies

  • External Service: Requires access to the Eskom API.
  • API Key: You must provide valid Eskom API credentials via the eskomApi credential type in n8n.
  • n8n Configuration: Ensure that the Eskom node is properly installed and configured within your n8n instance.

Troubleshooting

Common Issues:

  • Invalid Credentials: If the provided Eskom API credentials are incorrect or expired, the node will fail to authenticate.
  • Network Errors: Connectivity issues between n8n and the Eskom API endpoint can cause failures.
  • API Rate Limits: Exceeding Eskom API usage limits may result in errors or throttling.

Common Error Messages & Resolutions:

  • "Authentication failed": Check and update your Eskom API credentials in n8n.
  • "Request timed out": Verify network connectivity and Eskom API availability.
  • "API allowance exceeded": Wait before making further requests or check your API plan/limits.

Links and References

Discussion