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

      Instantiation

      Updated 21 May 2023 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

      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.

      Instantiation of Fields

      Here is an example of instantiating webhook template fields:

      fields:
      - id: token
        name: Authentication token
        description: The token used for authentication
        secret: true
        default-value:
      - id: username
        name: Username
        description: The username used on the service
        secret: false
        default-value:
      - id: create
        name: Create device
        description: If set to true, the device will automatically be created on the first uplink
        secret: false
        default-value: "true"
      

      Instantiation of header values, URLs and paths will be explained below using this example.

      If the webhook template is to be defined without fields, define the fields as follows:

      fields: []
      

      or

      fields:
      

      Instantiation of Header Values

      The fields are directly replaced in the values of the headers using the syntax {field-id}. Consider the fragment of a webhook template presented above - the headers to be sent to the endpoint can be defined, using the available template fields, for example as:

      headers:
      - Authorization: Bearer {token}
      

      If the user has filled in the value of token with Zpdc7jWMvYzVTeNQ, then the resulting webhook will contain a header named Authorization with the value Bearer Zpdc7jWMvYzVTeNQ.

      Keep in mind that if you need to use a field directly as header value, you should wrap it with hyphens as follows:

      headers:
      - Authorization: "{token}"
      

      If the webhook template is to be defined without header entries, define the headers field as follows:

      headers: {}
      

      or

      headers:
      

      Instantiation of URLs and Paths

      The fields are replaced inside the URLs and the paths according to the RFC6570 format. Consider the fragment of a webhook template shown above - the base URL and paths of the endpoint can be defined, using the available template fields, for example as:

      baseurl: https://www.example.com/lora{/username}
      paths:
      - uplink-message: /uplink{?create}
      

      If the user has filled in the value of username with user1 and the value of create with true, then the resulting webhook will have its base URL set to https://www.example.com/lora/user1 and the uplink messages will be sent to https://www.example.com/lora/user1?create=true (the uplink messages path will be set to /uplink?create=true).

      Instantiation of Field Mask

      The request message data fields that are sent via webhooks can be filtered. If specified in field-mask, only these fields will be present in the request message to save bandwidth. Field paths are provided as a list, for example:

      field-mask:
        - received_at
        - up.uplink_message
        - up.service_data
      

      When there are no paths in the field mask or there is no field-mask in the template, all fields will be present in the request message.

      For the full list of support fields, see Field Mask.

      ← Format Adding Webhook Templates →

      On this page

      • Instantiation of Fields
      • Instantiation of Header Values
      • Instantiation of URLs and Paths
      • Instantiation of Field Mask

      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