The Extension Object

The extension object (which is called app due to legacy reasons) contains the setting information of one of your Extension. To access this setting information, use the OAuth token provided through the extension or the personal access token. With the OAuth token, your extension can send a request to retrieve the setting information to the app_provisions endpoint.

You can find more information on how to get your OAuth token on our OAuth 2.0 Authorization Flow documentation. We mentioned an important endpoint, app_provisions and you can check examples in this section of our documentation.

To generate a personal access token, you can do that from My Account → Account Settings → Personal access token.

Properties

id
number

Numeric ID of the Extension
name
string

Name of the Extension
slug
string

The slug specific to this Extension
icon
string

Icon image path of the Extension from the Extension Details
plan_level
number

Plan Level of Space
preview_video
string

Define the video URL in the extension configured on the Extension Details in the settings
app_url
string

Extension URL
description
string

A description of your extension
intro
string

A short description of your extension
screenshot
string

A screenshot image path of your extension
status
string

Status of the extension
website
string

Website URL of your extension
author
string

Author of the extension
updated_at
string

Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
field_type_ids
number[]

An array of field type ids
embedded_app_url
string

An embedded Space app or Tool Plugin URL
dev_embedded_app_url
string

A developer mode of embedded Space Plugin or Tool Plugin URL
dev_oauth_redirect_uri
string

A developer mode of OAuth Space Plugin or Tool Plugin URI
in_sidebar
boolean

A status in the sidebar if your plugin is a space app
in_toolbar
boolean

A status in the toolbar if your plugin is tool plugin
sidebar_icon
string

Your space app sidebar icon image path
oauth_redirect_uri
string

OAuth Space Plugin or Tool Plugin URI
enable_space_settings
boolean

A status to show whether your extension is enabled for space level settings or not

Example Object

{
  "app": {
    "id": 12345,
    "name": "My first plugin",
    "slug": "my-first-plugin",
    "icon": "//a.storyblok.com/app-assets/1/833729bae2/my_plugin.png",
    "plan_level": null,
    "preview_video": "https://this-is-a-video.com",
    "app_url": null,
    "description": "This is my plugin description.",
    "intro": "This is a short description.",
    "screenshot": "//a.storyblok.com/app-assets/1/a8295d3fe0/screenshot.jpg",
    "status": "created",
    "website": "https://this-is-a-website.com",
    "author": "Arisa Fukuzaki",
    "updated_at": "2024-04-10T12:08:48.617Z",
    "field_type_ids": [],
    "embedded_app_url": null,
    "dev_embedded_app_url": null,
    "dev_oauth_redirect_uri": null,
    "in_sidebar": true,
    "in_toolbar": false,
    "sidebar_icon": null,
    "enable_space_settings": true
  },
  "granted": false
}

Prev Introduction

Next The App Provision Object