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
      • Webhooks
        • Creating Webhooks
        • Scheduling Downlinks
        • Webhook Path Variables
        • Webhook Retries
        • Webhook Templates
          • Format
          • Instantiation
          • Adding Webhook Templates
        • Troubleshooting Webhooks
      • Storage Integration
      • Integrate with popular IoT platforms
      • Other integrations
      • Application Packages
      • Examples

      Webhook Templates

      Updated 21 October 2020 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

      Webhook templates define a webhook integration that is not yet created. Templates allow using common values for many webhooks, such as a common base URLs.

      Webhook templates are primarily targeted at service providers who want to create specialized webhook integrations for the users of The Things Stack.

      Typical use cases

      1. Create a webhook with a personalized base URL, format and message paths.
      2. Provide users with additional information about the webhook itself, using documentation and visual aids.
      3. Simplify the process of enabling the integration by removing the manual work of the user.

      How does it work?

      Webhook templates can be used to pre fill the common values of a webhook integration such as the base URL, the message paths or the provided headers. They also allow input from the user, in the form of fillable fields, which are then replaced in the template by the Console in order to obtain the concrete webhook.

      See Template Format for more information on the contents of a webhook template and Template Instantiation for more information of the process through which a webhook template, with user input, is converted into a webhook integration.

      Format

      Webhook templates are described using the YAML language. Their format is very closely related to that of a normal webhook integration, but with additional fields added.
      Read

      Instantiation

      The process through which a webhook template becomes a webhook integration is called instantiation. Instantiation is done by the Console after the user has filled in the values of the the template fields. This page describes how the template and the values are combined into the final webhook instance.
      Read

      Adding Webhook Templates

      The Things Stack uses Webhook templates from the lorawan-webhook-templates Github repository. The lorawan-webhook-templates repository is open source, so users are free to submit pull requests to add new Webhook templates. Naturally, before submitting a new Webhook template in a pull request, one would want to test if the template is correct, i.e. if it yields an integration that is working as expected. A common way to test a newly built Webhook template is to deploy The Things Stack on a local machine (see installation), while configuring the deployment to use the locally stored Webhook templates.
      Read
      ← Webhook Retries Format →

      On this page

      • How does it work?

      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