Skip to content
Plune Plune Plune Docs

Your notifications in this project

GET
/v1/notifications
 
curl --request GET \
  --url 'https://beta-api.plune.ai/v1/notifications?limit=30' \
  --header 'Authorization: Bearer <token>'

The bell’s list (#1063): only yours, in the project the request runs in; a person in two projects has two lists. Unread first, then read, each newest first. limit is 1 to 100 (30 when left out); nextCursor is opaque and null at the end. A notification read between two pages can show again in the read half, never be missed. The words are not stored finished: textKey names a dictionary entry of the dashboard and params (a flat object) fills it, so the text follows the person’s language. entity is what it is about (bug and an id). Notifications are made by the event they tell of, in that event’s transaction - a rolled-back event leaves none - and there is no route that creates one. A reader is told nothing in this version: the list is empty. Read ones are deleted 30 days after they were read, unread ones 90 days after they were made.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Plune-Project
string

Which of your projects to act in — an id from GET /v1/projects. Absent, your default project. A project you are not a member of answers 404, the same as one that does not exist. Ignored under a bearer token, which is bound to the project it was minted in.

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 30 >= 1 <= 100
cursor
string

The nextCursor of the previous page, as given.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A page of notifications

Media type application/json
object
notifications
required
Array<object>

One thing told to one person in one project. The text is not stored finished: the dashboard words it from textKey and params in the person’s language. kind is from a closed list - for a bug (ADR 0057, #1067) bug.can_be_closed, bug.auto_closed, bug.reopened_by_regression and bug.fails_again (a case failed after the bug was closed by hand; it stays closed); a client shows an unknown kind by its textKey and does not fail.

object
id
required
string format: uuid
projectId
required
string
kind
required
string
Allowed values: bug.can_be_closed review.merged bug.auto_closed bug.reopened_by_regression bug.fails_again
entity
required

What it is about: the link the list opens.

object
kind
required
string
Allowed values: bug review_item
id
required
string
textKey
required

The dashboard dictionary entry that words it.

string
<= 120 characters
params
required

Flat values for the text; at most 2048 bytes as JSON.

object
key
additional properties
One of:
string
createdAt
required
string format: date-time
readAt
required

Null while unread.

string format: date-time
nullable
nextCursor
required
string
nullable
Example 
{
  "notifications": [
    {
      "kind": "bug.can_be_closed",
      "entity": {
        "kind": "bug"
      }
    }
  ]
}

400

Section titled “400 ”

limit is not an integer from 1 to 100, or cursor is not one this API gave

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

401

Section titled “401 ”

No / invalid token or session

404

Section titled “404 ”

The project named in X-Plune-Project is not one of yours

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}