# Documentation (https://logable.app/docs)

Guides for using the app, integration pages for getting readings in and alerts out, and reference tables generated from the product.



Logable watches your equipment and tells you before something goes wrong. These pages show you how to use the app and how to connect to it.

Start with the question you have. Each section answers a different kind.

## Start here [#start-here]

If you are new, read these four pages in order.

1. [Get started with Logable](/docs/guides/getting-started)
2. [Send your first reading](/docs/integrate/quickstart)
3. [Send readings over HTTP](/docs/integrate/rest-api)
4. [Device types](/docs/reference/device-types)

## Guides [#guides]

Do one thing in the app. Each guide is a task, with the screens you will see.

- [Get started with Logable](/docs/guides/getting-started). Create your organization, connect your first device, and put it on a dashboard. About fifteen minutes from start to finish.
- [Dashboards](/docs/guides/dashboards). Add widgets to a dashboard and arrange them for the team who watches them.
- [Devices](/docs/guides/devices). Connect a device and manage its token, including how to rotate or revoke it.
- [Equipment](/docs/guides/equipment). Step by step guides for the equipment Logable watches, from adding the device to the alert that reaches a phone.
- [Streams](/docs/guides/streams). Send data that is not tied to one device by using a stream instead.
- [Alerts](/docs/guides/alerts). Get alerted before a limit is crossed, from a preset or a rule you build.
- [Organizations](/docs/guides/organizations). Invite your team and understand what each role can see and do.
- [Reports](/docs/guides/reports). Build a report and choose what it covers and when it sends.
- [White-label](/docs/guides/white-label). Put your brand on the app and register the client organizations you manage.
- [Mobile app](/docs/guides/mobile). Get the mobile app and sign in with your existing account.

## Integrate [#integrate]

Get readings into Logable and alerts out of it.

- [Send your first reading](/docs/integrate/quickstart). From a device token to a value on a dashboard in five minutes, with HTTP or MQTT.
- [Send readings over HTTP](/docs/integrate/rest-api). POST a device reading to the ingest service with a device token. Payload, validation rules, error codes and rate limits.
- [Publish readings over MQTT](/docs/integrate/mqtt). Connect to the Logable broker over TLS with a device token and publish readings on the device's own topic.
- [Send stream events](/docs/integrate/streams-ingest). Post events to a stream when the data is not a device. Same body shape, its own token, no status field.
- [Send a field the device type does not define](/docs/integrate/custom-data-points). Add your own keys to a reading. They are stored and shown, but they never drive an alert or a forecast.
- [Device tokens](/docs/integrate/device-tokens). How a device token works, how to rotate one without a gap, and what a revoked token sees.
- [Connect a PLC or a Modbus device via a gateway](/docs/integrate/connect-plcs-and-modbus-via-a-gateway). Logable ingests HTTP and MQTT. A gateway reads your PLC or Modbus registers and publishes each reading on the device's topic.
- [Receive alerts as an HTTP call](/docs/integrate/webhooks-out). Register a webhook endpoint, verify the signature, and handle retries and replays.
- [Rate limits and payload limits](/docs/integrate/rate-limits-and-payload-limits). Which limit applies to a device, a gateway, a stream and a signed-in user, and what to do when you hit one.

A PLC or a Modbus device reaches Logable through a gateway that publishes over MQTT. The MQTT page explains how.

## Reference [#reference]

Facts about the platform, generated from the product so they cannot drift.

- [Device types](/docs/reference/device-types). Every device type Logable ships, grouped by category, with the metrics and configuration each one accepts.
- [Ingest payload schema](/docs/reference/ingest-payload-schema). The JSON body a device or stream sends, field by field, with the limits the ingest service enforces.
- [Error codes](/docs/reference/error-codes). Every HTTP status and code the ingest service returns, and what to do about each.
- [Limits](/docs/reference/limits). Organization defaults, payload limits, custom key limits and rate limits, read from the platform's own constants.
- [Webhook events](/docs/reference/webhook-events). The envelope, event types, signature headers, retry schedule and automatic switch-off rules for outbound webhooks.
- [Forecasts](/docs/reference/forecasts). Which device types get a depletion estimate, what it reads, and when Logable declines to estimate.