{ "opencollection": "1.0.0", "info": { "name": "Smokeball Activity Codes Plugins API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Plugins", "type": "folder" }, "items": [ { "info": { "name": "Get a plugin", "type": "http" }, "http": { "method": "GET", "url": "https://api.smokeball.com/plugins/:pluginId", "params": [ { "name": "pluginId", "value": "", "type": "path" } ] }, "docs": "Returns the plugin." }, { "info": { "name": "Update existing plugin", "type": "http" }, "http": { "method": "PUT", "url": "https://api.smokeball.com/plugins/:pluginId", "params": [ { "name": "pluginId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a plugin with the specified plugin details." }, { "info": { "name": "Delete existing plugin", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.smokeball.com/plugins/:pluginId", "params": [ { "name": "pluginId", "value": "", "type": "path" } ] }, "docs": "Deletes an existing plugin by id." }, { "info": { "name": "Get plugins", "type": "http" }, "http": { "method": "GET", "url": "https://api.smokeball.com/plugins", "params": [ { "name": "Offset", "value": "", "type": "query" }, { "name": "Limit", "value": "", "type": "query" } ] }, "docs": "Returns existing plugins." }, { "info": { "name": "Create a new plugin", "type": "http" }, "http": { "method": "POST", "url": "https://api.smokeball.com/plugins", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new plugin with the specified plugin details." }, { "info": { "name": "Request plugin URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.smokeball.com/plugins/:pluginId/url", "params": [ { "name": "pluginId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requests a secure URL from the plugin's endpoint for invoking the plugin.\r\nAccepts additional key/value pairs to pass to the plugin endpoint.\r\nReserved keys (AccountId, UserId, UserEmail, MatterId, AppId, EmbedToken) cannot be included in AdditionalData." }, { "info": { "name": "Get a plugin subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.smokeball.com/plugins/:pluginId/subscriptions/:id", "params": [ { "name": "pluginId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns the plugin subscription." }, { "info": { "name": "Unsubscribes account from plugin", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.smokeball.com/plugins/:pluginId/subscriptions/:id", "params": [ { "name": "pluginId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Unsubscribes an account from the specified plugin." }, { "info": { "name": "Get plugin subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.smokeball.com/plugins/:pluginId/subscriptions", "params": [ { "name": "pluginId", "value": "", "type": "path" }, { "name": "Offset", "value": "", "type": "query" }, { "name": "Limit", "value": "", "type": "query" } ] }, "docs": "Returns plugin subscriptions for the account." }, { "info": { "name": "Subscribe account to plugin", "type": "http" }, "http": { "method": "POST", "url": "https://api.smokeball.com/plugins/:pluginId/subscriptions", "params": [ { "name": "pluginId", "value": "", "type": "path" } ] }, "docs": "Subscribes an account with the specified plugin." } ] } ], "bundled": true }