1. Tasks
  2. Create LID

Tasks

Create LID

A LID (Link ID) lets you store a data payload inside Stubber and pass a lightweight reference to it out into the world. When that reference comes back — via a webhook, a reply, or a callback — you can retrieve the original data exactly as it was stored, with no risk of it being modified in transit.

This makes LIDs useful anywhere you need to carry context through an external system but want to keep the data safe, minimal, and verifiable.

Uses

  • Embed context in outbound links or QR codes without exposing raw data
  • Route webhook callbacks back to the right stub and state
  • Pass structured data into external APIs using only a short reference
  • Verify that data returned from an external system has not been tampered with

Basic usage

Create a LID with some data

loading...

Parameters

data
Required
JSON
  • Any JSON data you wish to store in the LID
  • This data will be passed through to any system that references it
  • Webhooks can use lids when passing data

is_public
Required
Bool
  • When true the lid can be retrieved by anyone who has the lid using the get_lid task.

read_limit
Optional
Number
  • Limits the number of times the LID can be read
  • Once the limit is reached the LID will no longer return data

Result

loading...

Properties

lid
String

The ID of the LID

Examples

Here is some more complex examples

Using a Lid in a webhook

You can use the LID to pass data without needing to send any data via webhooks

        GET /ex/UUID/LID HTTPS/1.1
Host: webhooks.stubber.com
Content-Type: application/json

      
Result
        GET /ex/UUID/hJJuk2ZfMI7tUuPe HTTPS/1.1
Host: webhooks.stubber.com
Content-Type: application/json

      
loading...

See also

  • get_lid — Retrieve the data stored in a LID