Create a notification
curl --request POST \
--url https://api.smokeball.com/notifications \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"staffId": "832e778f-83df-454a-b344-768a862a7e67",
"icon": "",
"iconColor": "#25C9A4",
"message": "[@staffId] has **assigned** you a Task.",
"toastyIcon": "<string>",
"toastyMessage": "<string>",
"actionUri": "<string>"
}
'import requests
url = "https://api.smokeball.com/notifications"
payload = {
"staffId": "832e778f-83df-454a-b344-768a862a7e67",
"icon": "",
"iconColor": "#25C9A4",
"message": "[@staffId] has **assigned** you a Task.",
"toastyIcon": "<string>",
"toastyMessage": "<string>",
"actionUri": "<string>"
}
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({
staffId: '832e778f-83df-454a-b344-768a862a7e67',
icon: '',
iconColor: '#25C9A4',
message: '[@staffId] has **assigned** you a Task.',
toastyIcon: '<string>',
toastyMessage: '<string>',
actionUri: '<string>'
})
};
fetch('https://api.smokeball.com/notifications', 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/notifications",
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([
'staffId' => '832e778f-83df-454a-b344-768a862a7e67',
'icon' => '',
'iconColor' => '#25C9A4',
'message' => '[@staffId] has **assigned** you a Task.',
'toastyIcon' => '<string>',
'toastyMessage' => '<string>',
'actionUri' => '<string>'
]),
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/notifications"
payload := strings.NewReader("{\n \"staffId\": \"832e778f-83df-454a-b344-768a862a7e67\",\n \"icon\": \"\",\n \"iconColor\": \"#25C9A4\",\n \"message\": \"[@staffId] has **assigned** you a Task.\",\n \"toastyIcon\": \"<string>\",\n \"toastyMessage\": \"<string>\",\n \"actionUri\": \"<string>\"\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/notifications")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"staffId\": \"832e778f-83df-454a-b344-768a862a7e67\",\n \"icon\": \"\",\n \"iconColor\": \"#25C9A4\",\n \"message\": \"[@staffId] has **assigned** you a Task.\",\n \"toastyIcon\": \"<string>\",\n \"toastyMessage\": \"<string>\",\n \"actionUri\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/notifications")
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 \"staffId\": \"832e778f-83df-454a-b344-768a862a7e67\",\n \"icon\": \"\",\n \"iconColor\": \"#25C9A4\",\n \"message\": \"[@staffId] has **assigned** you a Task.\",\n \"toastyIcon\": \"<string>\",\n \"toastyMessage\": \"<string>\",\n \"actionUri\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Notifications
Create a notification
Creates a notification.
POST
/
notifications
Create a notification
curl --request POST \
--url https://api.smokeball.com/notifications \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"staffId": "832e778f-83df-454a-b344-768a862a7e67",
"icon": "",
"iconColor": "#25C9A4",
"message": "[@staffId] has **assigned** you a Task.",
"toastyIcon": "<string>",
"toastyMessage": "<string>",
"actionUri": "<string>"
}
'import requests
url = "https://api.smokeball.com/notifications"
payload = {
"staffId": "832e778f-83df-454a-b344-768a862a7e67",
"icon": "",
"iconColor": "#25C9A4",
"message": "[@staffId] has **assigned** you a Task.",
"toastyIcon": "<string>",
"toastyMessage": "<string>",
"actionUri": "<string>"
}
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({
staffId: '832e778f-83df-454a-b344-768a862a7e67',
icon: '',
iconColor: '#25C9A4',
message: '[@staffId] has **assigned** you a Task.',
toastyIcon: '<string>',
toastyMessage: '<string>',
actionUri: '<string>'
})
};
fetch('https://api.smokeball.com/notifications', 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/notifications",
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([
'staffId' => '832e778f-83df-454a-b344-768a862a7e67',
'icon' => '',
'iconColor' => '#25C9A4',
'message' => '[@staffId] has **assigned** you a Task.',
'toastyIcon' => '<string>',
'toastyMessage' => '<string>',
'actionUri' => '<string>'
]),
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/notifications"
payload := strings.NewReader("{\n \"staffId\": \"832e778f-83df-454a-b344-768a862a7e67\",\n \"icon\": \"\",\n \"iconColor\": \"#25C9A4\",\n \"message\": \"[@staffId] has **assigned** you a Task.\",\n \"toastyIcon\": \"<string>\",\n \"toastyMessage\": \"<string>\",\n \"actionUri\": \"<string>\"\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/notifications")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"staffId\": \"832e778f-83df-454a-b344-768a862a7e67\",\n \"icon\": \"\",\n \"iconColor\": \"#25C9A4\",\n \"message\": \"[@staffId] has **assigned** you a Task.\",\n \"toastyIcon\": \"<string>\",\n \"toastyMessage\": \"<string>\",\n \"actionUri\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/notifications")
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 \"staffId\": \"832e778f-83df-454a-b344-768a862a7e67\",\n \"icon\": \"\",\n \"iconColor\": \"#25C9A4\",\n \"message\": \"[@staffId] has **assigned** you a Task.\",\n \"toastyIcon\": \"<string>\",\n \"toastyMessage\": \"<string>\",\n \"actionUri\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Body
application/json-patch+jsonapplication/jsonapplication/*+json
Staff id to notify.
Example:
"832e778f-83df-454a-b344-768a862a7e67"
The icon to display for the notification.
Will be validated against the Smokeball icon sets.
Example:
""
The icon hex color to display for the notification.
Example:
"#25C9A4"
The message to display for the notification.
Supports basic markdown syntax, such as: ** bold **, -- italic --
Supports basic UI markdown syntax for staff member id, such as [@staffId]
Example:
"[@staffId] has **assigned** you a Task."
The toast notification icon to display for the notification.
The toast notification message to display for the notification.
The Smokeball uri to execute when the notification is clicked.
āI