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": {}
}
'

import requests

url = "https://api.smokeball.com/plugins/{pluginId}/url"

payload = {
    "matterId": "0c5a2296-9e02-4c58-bd14-b7467d4c9bcb",
    "additionalData": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({matterId: '0c5a2296-9e02-4c58-bd14-b7467d4c9bcb', additionalData: {}})
};

fetch('https://api.smokeball.com/plugins/{pluginId}/url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/plugins/{pluginId}/url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'matterId' => '0c5a2296-9e02-4c58-bd14-b7467d4c9bcb',
    'additionalData' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/plugins/{pluginId}/url"

	payload := strings.NewReader("{\n  \"matterId\": \"0c5a2296-9e02-4c58-bd14-b7467d4c9bcb\",\n  \"additionalData\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.smokeball.com/plugins/{pluginId}/url")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"matterId\": \"0c5a2296-9e02-4c58-bd14-b7467d4c9bcb\",\n  \"additionalData\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/plugins/{pluginId}/url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"matterId\": \"0c5a2296-9e02-4c58-bd14-b7467d4c9bcb\",\n  \"additionalData\": {}\n}"

response = http.request(request)
puts response.read_body

200

"<string>"

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<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 | null

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.