Data Submission API
Post real-time and historical tag data from any field device, controller, or SCADA system into Waterly. One endpoint accepts device identity and an array of named measurements with timestamps.
WaterlyConnect
Connect anything to Waterly.
WaterlyConnect is the data integration layer between your field hardware, industrial gateways, and Waterly's cloud platform. One REST endpoint. One JSON payload schema. Works from Node.js, Python, PowerShell, Ignition, or any device that can make an HTTP request.
2
Published APIs
5
Integration Runtimes
1
Payload Schema
// POST https://app.waterlyapp.com/connect/submit
// x-waterly-request-type: WaterlyConnect
// x-waterly-connect-token: <your-token>
{
"timestamp": 1629489199,
"device": {
"id": "lift-station-04",
"type": "SCADA Gateway"
},
"tags": [
{
"name": "WetWellLevel",
"value": "12.7",
"last_change_timestamp": 1629489199
}
]
}
Quick Start
From credentials to first payload in four steps.
WaterlyConnect has one endpoint and one schema. The shortest path to your first accepted submission.
01
Request credentials
Contact Waterly support to receive your submission URL, client token, device id, and device type.
02
Pick a runtime
Choose the client or gateway guide that matches your environment — SDK, script, or importable project archive.
03
Send a test payload
Submit a few tag readings to confirm your device identity and token are accepted by the WaterlyConnect endpoint.
04
Schedule production runs
Wire a timer, cron job, or gateway event to submit on your preferred interval — typically every 5–15 minutes.
Published APIs
Two API surfaces for two integration patterns.
Data submission for field devices. Identity sync for organizations managing external user directories.
External User Directory API
Implementor contract for organizations that maintain their own user directory and want Waterly to sync users and role assignments bidirectionally. Your system exposes these endpoints; Waterly calls them.
Integration Directory
Pick the runtime that fits your environment.
SDKs for server-side jobs, scripts for operational automation, and gateway projects for plant-floor submissions.
SDK
Node.js Client
TypeScript/JS package for server-side adapters, ETL jobs, and integration services.
SDK
Python Client
Zero-dependency single-file module for scripts, cron jobs, and lightweight services.
SDK
PowerShell Module
Windows-native cmdlets for operator-driven scripts and Task Scheduler automation.
Gateway
Ignition Project
Importable project archive for scheduled gateway submissions from Inductive Automation Ignition.
Gateway
VTScada Integration
Script module and CSV tag list using VTScada's native HTTPSend. Configure tag schedules in a CSV file — no external server needed.
Gateway
Ewon Flexy Script
On-device BASIC script for Flexy 205 edge gateways — no external server required.
Your Runtime
Don't see yours?
Running something else — Allen-Bradley, Modbus, FactoryTalk, a custom data historian? The API is open. We can help build it.
Need credentials or implementation support?
Reach out to the Waterly team to receive your submission endpoint, client token, and device identity. Support is also available for rollout questions and environment-specific configuration.