org.cairnsproto.draft.listNotifications

Events for a DID, oldest first, after a cursor. Each names the records it was derived from. Read state stays with the client.

Repository @cairnsproto.org did:plc:np7ezqujtsry4bkogisaabul namespace authority
Details · query
Kindquery
Authoritydraft.cairnsproto.org
Commit rev3mzxyqlge4d2g
Indexed

Query

query · GET

Parameters

query string

cursor

string
  • maxLength: 1024

did

requiredstring · did

limit

integer
  • minimum: 1
  • maximum: 100
  • default: 50

Output

application/json

cursor

string

Where the next page starts. Present when more notifications follow.

  • maxLength: 1024

notifications

requiredarray
itemsref
Reference

#notification

object

Properties

cursor

requiredstring

The cursor that lists the events after this one.

  • maxLength: 1024

kind

requiredstring
  • maxLength: 64
  • knownValues: contested | hollow | lostLead | issueComment | issueState | diverges | drawClosing | versionWaiting | versionActive | escalated | dormancyAging | dormant | followedStone | exported | corrected

project

requiredref

records

requiredarray

The records the event was derived from: the snapshot and the one it names as previous, the comment or issueState, the import result, the project version, the pending work's record, the stone, or the export and any earlier export it corrects. Empty for drawClosing, which the beacon raises.

itemsref

seenRound

requiredinteger

When the indexer saw the record that raised the event, or for an event the round raises (drawClosing, versionActive, dormancyAging, dormant), the round it came due.

  • minimum: 1

site

string

The key (hex) of the site the event is about.

  • minLength: 64
  • maxLength: 64

subject

requiredref

The recipient's stone (contested, hollow, lostLead, diverges), the issue, the followed sponsor's stone, the export, the waiting project version, the pending maintainer work's record, or for drawClosing the project.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.