Create a new plugin

curl --request POST \
  --url https://api.smokeball.com/plugins \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "externalId": "<string>",
  "application": "Native",
  "type": "Button",
  "version": {
    "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>"
      ]
    }
  },
  "key": "<string>",
  "additionalData": {}
}
'

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

POST

plugins

Create a new plugin

curl --request POST \
  --url https://api.smokeball.com/plugins \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "externalId": "<string>",
  "application": "Native",
  "type": "Button",
  "version": {
    "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>"
      ]
    }
  },
  "key": "<string>",
  "additionalData": {}
}
'

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Body

externalId

string | null

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

application

enum<string>

The application that the plugin should be rendered in.

Available options:

Native,

Web,

Archie

type

enum<string>

The type of component the plugin should represent.

Available options:

Button,

Tab

version

object

Current version of the plugin.

Show child attributes

version.name

string | null

The name of the plugin.

version.description

string | null

A description of the plugin.

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.

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.

version.attributes

object

Visual attributes associated to this plugin.

Show child attributes

version.attributes.text

string | null

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

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.

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).

version.attributes.page

object

Page attributes for the plugin (where applicable).

Show child attributes

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.

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.

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.

version.attributes.page.useDefaultBrowser

boolean

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

version.availability

object

Optional settings for determining the availability of a plugin.

Show child attributes

version.availability.matterTypeIds

string[] | null

Optional matter types applicable for the plugin.

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

key

string | null

Signing key of the plugin to verify integrity of requesting secure URLs. Only available to set on Plugin creation.

additionalData

object

Collection of KeyValuePair(string, object) to update Plugin meta data.

Show child attributes

additionalData.{key}

any

Response

When request is accepted. Returns a 'Link' object.

string | null

href

string | null

relation

string | null

method

string | null

default:GET

Get plugins Get a plugin subscription

⌘I

Documentation

Tutorials

APIs

Create a new plugin

Authorizations

Body

Response