Get plugins

curl --request GET \
  --url https://api.smokeball.com/plugins \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "externalId": "<string>",
      "application": "Native",
      "type": "Button",
      "version": {
        "id": "<string>",
        "pluginId": "<string>",
        "versionNumber": 123,
        "name": "<string>",
        "description": "<string>",
        "placement": "<string>",
        "requestEndpointUrl": "<string>",
        "attributes": {
          "text": "<string>",
          "icon": "<string>",
          "color": "<string>",
          "tooltip": "<string>",
          "page": {
            "title": "<string>",
            "width": 123,
            "height": 123,
            "useDefaultBrowser": true
          }
        },
        "availability": {
          "matterTypeIds": [
            "<string>"
          ]
        },
        "createdDate": "2020-02-15T00:00:00Z",
        "lastUpdatedDate": "2020-02-15T00:00:00Z"
      },
      "lastUpdated": 637847425252027400,
      "createdDate": "2020-02-15T00:00:00Z",
      "lastUpdatedDate": "2020-02-15T00:00:00Z",
      "key": "<string>",
      "additionalData": {}
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

GET

plugins

Get plugins

curl --request GET \
  --url https://api.smokeball.com/plugins \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "externalId": "<string>",
      "application": "Native",
      "type": "Button",
      "version": {
        "id": "<string>",
        "pluginId": "<string>",
        "versionNumber": 123,
        "name": "<string>",
        "description": "<string>",
        "placement": "<string>",
        "requestEndpointUrl": "<string>",
        "attributes": {
          "text": "<string>",
          "icon": "<string>",
          "color": "<string>",
          "tooltip": "<string>",
          "page": {
            "title": "<string>",
            "width": 123,
            "height": 123,
            "useDefaultBrowser": true
          }
        },
        "availability": {
          "matterTypeIds": [
            "<string>"
          ]
        },
        "createdDate": "2020-02-15T00:00:00Z",
        "lastUpdatedDate": "2020-02-15T00:00:00Z"
      },
      "lastUpdated": 637847425252027400,
      "createdDate": "2020-02-15T00:00:00Z",
      "lastUpdatedDate": "2020-02-15T00:00:00Z",
      "key": "<string>",
      "additionalData": {}
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Query Parameters

Offset

integer<int32>

Required range: 0 <= x <= 2147483647

Limit

integer<int32>

Required range: 1 <= x <= 500

Response

200 - application/json

When request is successful. Returns a paged collection of 'Plugin' objects.

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object

Show child attributes

self.id

string | null

self.href

string | null

self.relation

string | null

self.method

string | null

default:GET

value

object[] | null

Show child attributes

value.id

string | null

value.href

string | null

value.relation

string | null

value.method

string | null

default:GET

value.self

object

Show child attributes

value.self.id

string | null

value.self.href

string | null

value.self.relation

string | null

value.self.method

string | null

default:GET

value.externalId

string | null

Optional id provided by the external system that owns this plugin.

value.application

enum<string>

The application that the plugin should be rendered in.

Available options:

Native,

Web,

Archie

value.type

enum<string>

The type of component the plugin should represent.

Available options:

Button,

Tab

value.version

object

Current version of the plugin.

Show child attributes

value.version.id

string | null

Unique identifier of the plugin version.

value.version.pluginId

string | null

The plugin id this version is associated to.

value.version.versionNumber

integer<int32>

The associated version number.

value.version.name

string | null

The name of the plugin.

value.version.description

string | null

A description of the plugin.

value.version.placement

string | null

A placement key representing where the plugin should be rendered in the UI. Placement key must correspond to the type of the plugin. Refer to documentation for valid placement keys.

value.version.requestEndpointUrl

string | null

The url that is called to request the plugin endpoint.

When a user views a plugin, we request the url to view securely through your backend.

Matter and user information is passed to the endpoint through POST body, and the endpoint is expected to return a JSON object containing a url field. The plugin will then load the URL and display it to the user.

value.version.attributes

object

Visual attributes associated to this plugin.

Show child attributes

value.version.attributes.text

string | null

The text to be rendered on the plugin component (where applicable).

value.version.attributes.icon

string | null

The Icon to be rendered on the plugin component (where applicable). Refer to documentation for a full list of icons.

value.version.attributes.color

string | null

The hex color code to be rendered on the plugin component (where applicable).

Optional: The tooltip to display on component hover (where applicable).

value.version.attributes.page

object

Page attributes for the plugin (where applicable).

Show child attributes

value.version.attributes.page.title

string | null

Optional: The title of the page rendered by the plugin (where applicable). If not specified, the name of the plugin will be used.

value.version.attributes.page.width

integer<int32>

Optional: The width of the page rendered by the plugin (where applicable). If not specified, a default width will be used.

value.version.attributes.page.height

integer<int32>

Optional: The height of the page rendered by the plugin (where applicable). If not specified, a default width will be used.

value.version.attributes.page.useDefaultBrowser

boolean

Optional: Override browser behavior. When true, loads the endpoint in the internal browser (where applicable).

value.version.availability

object

Optional: Settings for determining the availability of a plugin.

Show child attributes

value.version.availability.matterTypeIds

string[] | null

Optional matter types applicable for the plugin.

Plugin is applicable for all matter types if this is left empty.

value.version.createdDate

string<date-time>

Plugin version created date in UTC

Example:

"2020-02-15T00:00:00Z"

value.version.lastUpdatedDate

string<date-time>

Plugin version last updated date in UTC

Example:

"2020-02-15T00:00:00Z"

value.lastUpdated

integer<int64>

Last updated timestamp.

Example:

637847425252027400

value.createdDate

string<date-time>

Plugin created date in UTC.

Example:

"2020-02-15T00:00:00Z"

value.lastUpdatedDate

string<date-time>

Plugin last updated date in UTC.

Example:

"2020-02-15T00:00:00Z"

value.key

string | null

Signing key of the plugin to verify integrity of requesting secure URLs.

value.additionalData

object

Collection of plugin meta data as KeyValuePair(string, object).

Show child attributes

value.additionalData.{key}

any

offset

integer<int32> | null

limit

integer<int32> | null

size

integer<int64>

first

object

Show child attributes

first.id

string | null

first.href

string | null

first.relation

string | null

first.method

string | null

default:GET

object

Show child attributes

previous.id

string | null

previous.href

string | null

previous.relation

string | null

previous.method

string | null

default:GET

object

Show child attributes

next.id

string | null

next.href

string | null

next.relation

string | null

next.method

string | null

default:GET

last

object

Show child attributes

last.id

string | null

last.href

string | null

last.relation

string | null

last.method

string | null

default:GET

Delete existing plugin Create a new plugin

⌘I

Documentation

Tutorials

APIs

Get plugins

Authorizations

Query Parameters

Response