Skip to main content
GET
/
notifications
/
{id}
Get a notification
curl --request GET \
  --url https://api.smokeball.com/notifications/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.smokeball.com/notifications/{id}"

headers = {
"x-api-key": "<api-key>",
"Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/notifications/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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"
"net/http"
"io"
)

func main() {

url := "https://api.smokeball.com/notifications/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.smokeball.com/notifications/{id}")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/notifications/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "e2fd015b-8a60-42be-9ea4-b2ef7aa0289b",
  "createdByUserId": "db0b4298-67ef-4638-a92a-5bb830ea6af6",
  "createdDate": "\"832e778f-83df-454a-b344-768a862a7e67\"",
  "icon": "",
  "iconColor": "#25C9A4",
  "message": "[@staffId] has **assigned** you a Task.",
  "toastyIcon": "<string>",
  "toastyMessage": "<string>",
  "isRead": false,
  "hasBeenSeen": false,
  "creationTimestamp": "2023-11-07T05:31:56Z",
  "updatedDate": "2020-02-15T00:00:00Z",
  "isDeleted": false
}
{
"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

id
string
required

Response

When request is successful. Returns a 'Notification' object.

href
string | null
relation
string | null
method
string | null
default:GET
self
object | null
id
string | null

Unique identifier of the notification.

Example:

"e2fd015b-8a60-42be-9ea4-b2ef7aa0289b"

createdByUserId
string | null

The user that created this notification.

Example:

"db0b4298-67ef-4638-a92a-5bb830ea6af6"

createdDate
string | null

Staff id to notify.

Example:

"\"832e778f-83df-454a-b344-768a862a7e67\""

icon
string | null

The icon to display for the notification.

Example:

""

iconColor
string | null

The icon hex color to display for the notification.

Example:

"#25C9A4"

message
string | null

The message to display for the notification.

Example:

"[@staffId] has **assigned** you a Task."

toastyIcon
string | null

The icon to display for the toast notification.

toastyMessage
string | null

The message to display for the message.

isRead
boolean

True if the notification has been forcefully read by the user.

This is different to the property - which is not forceful.

Example:

false

hasBeenSeen
boolean

True if the notification was "seen" by the user.

This is different to the forceful "read" state.

Example:

false

creationTimestamp
string<date-time>

The time the notification was created.

updatedDate
string<date-time>

The last time the notification was modified (marked as read, deleted etc).

Example:

"2020-02-15T00:00:00Z"

isDeleted
boolean

True if the notification has been deleted.

Example:

false