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 plugin URL

cURL

curl --request POST \
  --url https://api.smokeball.com/plugins/{pluginId}/url \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "matterId": "0c5a2296-9e02-4c58-bd14-b7467d4c9bcb",
  "additionalData": {}
}
'

200

"<string>"

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

pluginId · string<uuid> · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

matterId · string | null

The matter id associated with the request, if applicable.

Example:

"0c5a2296-9e02-4c58-bd14-b7467d4c9bcb"

additionalData · object

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

Show child attributes

Response

200

application/json

When request is successful. Returns the plugin URL.

The response is of type string.