Blinks Data Schema

Blinks have a variety of core and supporting data that let you create rich, interactive and educational experiences for your users.

Prefer less words? Check out our Open API docs

Blinks are an interactive data structure that can contain previews, detailed information, and actionable elements - all accessible through standardized API endpoints.

In this section we describe the full blinks data schema, the motivation behind the schema, how to fetch this data from blink URLs, and how to work with these data structures, as well as others such as Blink Lists, using the Terminal.

The Blinks Data Schema is comprised of the following key structures:

1. Blink

2. BlinkPreview

3. BlinkDataTable

Example of a BlinkPreview

Image of a Blink

Across these three data structures and supporting substructures, like the BlinkContext, you can create a variety of experiences for your users, including:

1. Core blink data, like image, title, description and associated actions.

2. Link preview-style cards for marketing purposes (BlinkPreview).

3. Enriched metadata for show users market data like APYs, wallet balances and other kinds of relevant, live information.

4. Social context and trust regarding the provider of the Blink (Provider via the BlinkContext).

In the following sections, we go over these data structures and how to fetch them.

For the fastest solution, consider integrating blinks into your application using our UI Component Libraries, available for both web and mobile. Using these libraries can reduce your integration time by up to 99%.

Blink

A Blink contains the complete, interactive data structure. It contains all necessary information to display and interact with a Blink, including its current state, possible actions, and related data.

This is the primary structure you'll work with when implementing Blink functionality in your application.

There is no requirement for the image dimension, so it can be 1:1 or 16:9.

Example of a full blink incl. DataTable and extendedDescription

Blink GET-Schema

// Blink GET-schema

{
  "type": "string",           // required, enum: ["action", "completed"]
  "icon": "string",           // required
  "title": "string",          // required
  "description": "string",    // required
  "extendedDescription": "string", // text below the data table (see next image)
  "label": "string",          // required, button text
  "disabled": "boolean",
  "message": "string",
  "context": BlinkContext,    // required, see core data structures
  "preview": BlinkPreview     // required, see core data structures
  "error": {
    "message": "string"
  },
  "links": {
    "actions": [
      {
        "type": ActionType,  // required, enum: ["transaction", "message", "post", "external-link", "inline-link"]
        "href": "string",    // required
        "label": "string",   // required, button text
        "parameters": []
      }      
    ],
    "dataTable": "string"
  }
}

Blink POST-schema

// Blink POST-schema example for a transaction

{
  "type": "transaction",
  "message": "string",
  "transaction": "string",
  "links": {
    "next": {
      "type": "post",
      "href": "string"
    }
  },
  "lifecycle": {
    "success": {
      "message": "string",
      "links": {
        "actions": [
          {
            "type": "inline-link",
            "label": "string",
            "link": "string"
          }
        ]
      }
    },
    "executing": {
      "message": "string"
    },
    "error": {
      "message": "string"
    }
  }
}

There are more POST types available, like message, external-link and post. Visit our API docs for more information.

BlinkPreview

BlinkPreview is a small, static set of data that can be used to display relevant data about the blink. Think of it more as a chance to use some marketing language and to render a preview, instead of the full blink, e.g. if you use it in a list or on a website that doesn't unfurl blinks yet.

It is also recommended to use a separate 16:9 image for this preview.

BlinkPreview example image

Schema

// BlinkPreview struct

{
  "image": "string",          // required
  "title": "string",          // required
  "description": "string",    // required
  "cta": "string",
  "context": BlinkContext,    // required, see core structures
  "links": {                  // required
    "blink": "string",        // required, URL to the blink
    "dataTable": "string"
  }
}

BlinkDataTable

BlinkDataTable is a structured, tabular representation of Blink-related data, designed for displaying detailed information in a key-value format. Perfect to highlight critical information such as APY, exchange rates etc.

Because many of these values are dynamic and could need more computation

Example of a BlinkDataTable

Schema

// BlinkDataTable struct

{
  "rows": [DataRow],        // required, see core data structures
  "context": BlinkContext,  // required, see core data structures
  "links": {                // required
    "blink": "string",      // required, URL to Blink endpoint
    "preview": "string"     // required, URL to BlinkPreview endpoint
  }
}