v3.23.1

Getting Started Devices Gateways Integrations Reference
Get The Things Stack

Integrations

    Overview
  • Adding Applications
  • Adding Integrations
  • Cloud Integrations
  • MQTT Server
  • Pub/Sub
  • LoRa Cloud
  • Node-RED
  • IFTTT
  • Payload Formatters
  • Storage Integration
  • Webhooks
    • Creating Webhooks
    • Scheduling Downlinks
    • Webhook Path Variables
    • Webhook Templates
      • Format
      • Instantiation
      • Adding Webhook Templates
    • Troubleshooting Webhooks

Webhook Templates

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 Path Variables Format →

On this page

  • How does it work?

The Things Stack

Getting Started

Devices

Gateways

Integrations

Reference

Contributing

GitHub

Forum

About Us

The Things Network

The Things Industries

About this page

Last changed by Nejra on 21 Oct 2020.
doc: Improving docs readability

Edit on Github