The Plugin Object

The plugin object (which is called app due to legacy reasons) contains the setting information of one of your Space Plugins or Tool Plugins. To access this setting information, use the OAuth token provided. With the OAuth token, your Space Plugin or Tool Plugin 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.

Properties

id
number

Space Plugin or Tool Plugin id
name
string

Space Plugin or Tool Plugin name
slug
string

The slug specific to this Space Plugin or Tool Plugin
icon
string

Icon image path of the Space Plugin or Tool Plugin from the Extension Details
plan_level
number

Plan Level of Space
preview_video
string

Define the video URL in the Space Plugin or Tool Plugin configured on the Extension Details in the settings
app_url
string

Space Plugin or Tool Plugin URL
description
string

A description of your Space Plugin or Too Plugin
intro
string

A short description of your Space Plugin or Tool Plugin
screenshot
string

A screenshot image path of your Space Plugin or Tool Plugin
status
string

Status of whether the Space Plugin or Tool Plugin is created or not
website
string

Website URL of your Space Plugin or Tool Plugin
author
string

Author of the Space Plugin or Tool Plugin
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 Plugin 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 Space Plugin
in_toolbar
boolean

A status in the toolbar if your plugin is Tool Plugin
sidebar_icon
string

Your Space Plugin sidebar icon image path
enable_space_settings
boolean

A status to show whether your Space Plugin or Tool Plugin is enabled for space level 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