SMsmokeball
Plugins

Request plugin URL

Requests a secure URL from the plugin's endpoint for invoking the plugin. Accepts additional key/value pairs to pass to the plugin endpoint. Reserved keys (AccountId, UserId, UserEmail, MatterId, AppId, EmbedToken) cannot be included in AdditionalData.

post/plugins/{pluginId}/url

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/plugins/{pluginId}/url
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

pluginIdstring uuid required

Request body

matterIdstring nullable

The matter id associated with the request, if applicable.

additionalDataobject nullable

Additional key/value pairs to pass to the plugin endpoint. Reserved keys (AccountId, UserId, UserEmail, MatterId) will be rejected.

Example request

{
  "matterId": "0c5a2296-9e02-4c58-bd14-b7467d4c9bcb"
}

Response

When request is successful. Returns the plugin URL.

string required

Changes

No recorded changes to this operation across all 15 revisions of this API.