Skip to main content

Introduction

Welcome to the Flow Webhooks documentation.

Flow Webhooks documentation enables businesses and partners to securely integrate with Flow's water infrastructure platform.
It provides real-time access, event-driven notifications, and controlled data sharing across devices, recharges, and water usage.

This documentation explains how to integrate, how data flows, and how to receive events.

What You Can Do With Flow Webhooks documentation​

Using this, you can:

  • Receive real-time device uplinks from meters
  • Get notified when recharges occur
  • Track water fetch and consumption events
  • Integrate Flow data into your own systems using webhooks

How the Platform Works​

At a high level:

  1. Devices, users, and services generate events within Flow
  2. Events are processed internally and validated
  3. Relevant events are forwarded to your system via webhooks
  4. Your application processes the data and acknowledges receipt

You do not need to poll Flow for updates — events are pushed to you automatically.

Integration Overview​

Flow integrations are built around:

  • API Clients – represent your application
  • Webhook URLs – where Flow sends event data
  • Event Types – define what data you receive
  • Business Scoping – ensures you only receive data you are authorized to access

Each integration is scoped per business and per event type.

Who This Documentation Is For​

This documentation is intended for:

  • Backend engineers integrating Flow into existing systems
  • Partners who need real-time operational data

Basic familiarity with:

  • HTTP
  • JSON
  • Webhooks
    is recommended.

If you're new to webhook integrations, we recommend starting with:

  • Webhooks – to learn how events are delivered to your system
  • Event Types – to understand what data you can receive