Skip to main content
POST
/
plugins
/
{pluginId}
/
url
Request plugin URL
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": {}
}
'
"<string>"

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
pluginId
string<uuid>
required

Body

ā€‹
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.

Response

When request is successful. Returns the plugin URL.

The response is of type string.