Skip to content
The Things Stack documentation home
Getting Started Concepts Cloud Enterprise Integrations API Hardware
Getting Started Concepts
Cloud Enterprise
Integrations API Hardware
Get The Things Stack

    Recent searches

      Popular pages

      • Getting Started
      • Adding Gateways
      • Adding Devices
      • Payload Formatters
      • Webhooks
      • Authentication

      No results for “”.

      • Check the spelling, or try fewer or more general words.
      • Ask the community on The Things Network Forum
      • Contact support
      ↑↓ to navigate ↵ to open Esc to close

      Integrations

      • Overview
      • Adding Applications
      • Data Formats
      • Payload Formatters
        • Creating Payload Formatters
        • CayenneLPP
        • Device Repository
        • JavaScript
      • Webhooks
      • Storage Integration
      • Integrate with popular IoT platforms
      • Other integrations
      • Application Packages
      • Examples

      Payload Formatters

      Updated 6 March 2025 Edit on GitHub
      Copy page
      • View as MarkdownThis page as plain text
      • Open in ChatGPTAsk questions about this page
      • Open in ClaudeAsk questions about this page

      Payload formatters allow you to process data going to and from end devices. This is useful for converting binary payloads to human readable fields, or for doing any other kind of data conversion on uplinks and downlinks.

      This section explains how to set up payload formatters for a specific end device or an entire application.

      In addition to the written instructions linked below, a video with instructions for creating JavaScript and device repository payload formatters is available on The Things Industries youtube channel.

      Show video

      Types of Payload Formatters

      The Things Stack supports three types of payload formatters: JavaScript, CayenneLPP, and Repository payload formatters.

      JavaScript

      The Things Stack allows you to write your own custom payload formatters in JavaScript. To find out how to write a custom JavaScript payload formatter, see the JavaScript Payload Formatters section.

      CayeneLPP

      The Things Stack can automatically decode CayenneLPP formatted payloads, no custom code neccessary. To find out how to use CayenneLPP payload formatters, see the CayenneLPP section.

      Repository

      Device manufacturers may submit payload formatters designed to work with their devices. These are publicly available in The Things Stack Device Repository.

      Device repository payload formatters work right out of the box – no customization needed!

      Application and Device Specific Payload Formatters

      Payload formatters can be applied to an entire application, or to a specific end device. Application payload formatters are useful if all devices use the same binary payload format, or as a fallback when no device specific payload formatter is set.

      Device payload formatters allow you to specify a unique payload formatter for each device.

      Note:

      Device payload formatters override application payload formatters.

      Working with Bytes

      To work with payload formatters, it is important to understand how payload data is encoded as binary bytes, and how to convert it to meaningful fields.

      To see how your device encodes environmental data, see your product datasheet.

      See The Things Network Learn for an introduction to working with bytes.

      Creating Payload Formatters

      This section explains how to set up Payload Formatters using the Console or CLI.
      Read

      CayenneLPP

      The Cayenne Low Power Payload (LPP) provides a convenient and easy way to send data over LPWAN networks such as LoRaWAN. The Cayenne LPP is compliant with the payload size restriction, which can be lowered down to 11 bytes, and allows the end device to send multiple sensor data at one time.
      Read

      Device Repository

      Device manufacturers may submit payload formatters designed to work with their devices. The data and code are publicly available in the Github Repository. You can find all devices in the Device Repository on this page. If you’re a device manufacturer and you would like to add your device to the repository, find out how here. Adding your device makes it easy for users to use it with The Things Stack, and is a good way to publicly document information and code related to your device.
      Read

      JavaScript

      JavaScript payload formatters allow you to write functions to encode or decode messages. JavaScript functions are executed using an JavaScript ECMAScript 5.1 runtime.
      Read
      ← Data Formats Creating Payload Formatters →

      On this page

      • Types of Payload Formatters
      • Application and Device Specific Payload Formatters
      • Working with Bytes

      Sections

      Getting Started

      Concepts

      Cloud

      Enterprise

      Integrations

      API

      Hardware

      Sitemap

      View our Sitemap

      Contributing

      GitHub

      About Us

      The Things Industries

      Privacy Policy

      Cookie settings

      Cookie Settings

      We use cookies to enhance your experience, analyze site traffic and deliver personalized content. Read our Privacy Policy.

      Cookie categories