NetPing AddIns Integration Guide: Automations, Alerts, and Scripts
This guide shows a practical, step-by-step approach to integrating NetPing AddIns to automate tasks, configure alerts, and run scripts for reliable remote device management. It assumes a working NetPing device with web access and basic familiarity with networking.
1. Overview: what AddIns do
NetPing AddIns extend built-in functionality by adding integrations (HTTP APIs, MQTT, syslog), scheduled tasks, and script hooks. Use them to automate power control, notify teams on events, and execute maintenance scripts.
2. Preparation — prerequisites
- NetPing device reachable on your network (IP address or hostname).
- Admin web access to the device.
- Optional: an MQTT broker, syslog server, or an automation server (Home Assistant, Node-RED).
- A small web server or endpoint for webhook-based actions (if using HTTP integrations).
- Basic shell or JavaScript knowledge for scripts.
3. Common integration patterns
- Webhook notifications: POST JSON to an endpoint on events (power loss, temperature threshold).
- MQTT publishing: device publishes telemetry or event topics for subscribers.
- Syslog forwarding: centralize logs and trigger downstream processing.
- Script execution: run server-side scripts on schedule or when triggers fire.
- REST API control: call device APIs from automation platforms to toggle relays or query sensors.
4. Configuring alerts
- Open the NetPing web UI and sign in as admin.
- Go to AddIns or Integrations section.
- Create a new alert rule:
- Select the trigger (input change, sensor threshold, ping failure).
- Choose condition values (e.g., temperature > 60°C, relay state = OFF).
- Select notification channel:
- Email/SMS (if supported): enter recipient and template.
- HTTP webhook: set method POST, URL, headers, and JSON body. Include placeholders for variables (sensor value, timestamp).
- MQTT: set broker, topic, QoS, and message payload.
- Syslog: set server address and facility/priority.
- Set escalation and repeat options (how often to resend, after how long).
- Save and test the alert using the device’s test/send option or by simulating the condition.
5. Automations: power control and maintenance
- Scheduled power cycling:
- In AddIns, create a scheduled task.
- Set time/frequency and action: toggle relay X OFF then ON (with delay).
- Use for rebooting unmanaged equipment on a nightly or weekly cadence.
- Conditional automation:
- Define triggers (e.g., sensor exceeds threshold).
- Add actions: cut power, notify operator, run a diagnostic script.
- Sequence actions:
- Chain multiple actions with delays (e.g., notify → wait 30s → power cycle → log).
6. Running scripts
NetPing AddIns typically support executing scripts or calling APIs:
- Script types:
- Local device scripts (if supported): lightweight shell or Lua scripts.
- Remote script via webhook: call your automation server to run heavier tasks.
- Best practices:
- Keep scripts idempotent and time-limited.
- Log outputs centrally (syslog or HTTP POST).
- Protect endpoints with authentication (API keys, basic auth, or tokens).
- Example webhook payload for triggering a remote script: { “device”: “netping-01”, “event”: “temp_high”, “value”: 72.4, “timestamp”: “2026-05-19T12:00:00Z” }
7. Integrating with Home Assistant and Node-RED
- Home Assistant:
- Use MQTT or REST to expose sensors and controls.
- Configure automations that call NetPing REST endpoints to toggle relays.
- Node-RED:
- Subscribe to MQTT or receive webhooks.
- Build flows that react to NetPing events and run multi-step logic (notify, wait, retry, power-cycle).
8. Security considerations
- Use HTTPS where possible for webhooks and REST calls.
- Require authentication for control endpoints (API tokens or basic auth).
- Limit network access to the device (firewall rules, VLANs).
- Rotate keys and monitor logs for suspicious activity.
9. Testing and verification
- Test each alert and automation in isolation.
- Use a staging or lab device where possible before production changes.
- Verify retries, escalation, and error handling behave as expected.
- Keep a change log of AddIn configurations and script versions.
10. Troubleshooting common issues
- No alerts sent: verify network connectivity, DNS, and credentials for the target endpoint.
- MQTT messages not received: confirm broker settings, topic names, and client credentials.
- Scripts not executing: check device support for script execution
Leave a Reply