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.

​
key
string | null

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

​
additionalData
object | null

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

Response

When request is successful. Returns a link to the plugin.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET