List the authenticated user's unread notifications

GET

/api/v1/notifications/unread

const url = 'http://localhost:11044/api/v1/notifications/unread';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/notifications/unread \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of unread notifications

*/*

Array<object>

A stored notification as the /notifications endpoints answer it. List-valued fields arrive as JSON-encoded strings

object

actionKind

Name of the recommended action kind, such as DRAFT_REPLY or ACK_ONLY. Null when there is nothing to act on

string

confidence

How sure the producer was that this matters, from 0 to 1. Null when it did not say

number format: double

consequenceOfInaction

One sentence on what happens if the user does nothing. Null on simple alerts

string

created

required

When the notification was generated, an ISO-8601 instant

string format: date-time

createdBy

required

Who produced it: “user” when the user asked for it, otherwise the producer’s id, such as “system” or engine.v1

string

deadline

When this stops being actionable, an ISO-8601 instant. Null when there is no hard deadline

string format: date-time

event

required

One-sentence headline saying what happened

string

required

Stable id, which the read and dismiss endpoints take in their path

string

kind

required

How it relates to earlier notifications on the same signals: ORIGINAL, UPDATE, CANCELLATION or COMPLETION

string

read

required

Whether the user has marked it read

boolean

recommendation

One sentence giving the recommended next step. Null on simple alerts

string

source

required

What produced it, such as github, build, email or calendar

string

sourceSignalIdsJson

required

The ids of the signals it was derived from, as a JSON-encoded array of strings

string

sourcesJson

required

The cited sources as a JSON-encoded array of {kind, id, displayLabel, url, typeName} objects; “[]” when there are none

string

supersedesJson

required

Ids of the earlier notifications it replaced, as a JSON-encoded array of strings

string

tier

required

Urgency tier name: AMBIENT, DEFERRED, TIMELY, INTERRUPTIVE, ACTING or ESCALATING

string

url

Link to act on it in the originating system. Null when there is none

string

userId

required

The user the notification belongs to; always the caller

string

whyItMatters

One sentence on why the user should care. Null on simple alerts

string