Skip to navigation

Get a notification endpoint

Serves one notification endpoint of the organisation, a deleted one included; any other id is 404. A member without the surface is 503 NOTIFICATIONS_UNAVAILABLE. Needs notifications:manage.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idintegerRequired

The record’s id — a positive 32-bit integer the platform minted.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

viewenumOptionalDefaults to latest

latest (the default) shows a row’s pending proposal where one exists; approved shows what the platform enforces. Resources without proposals serve the same rows for both.

Allowed values:
minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Response

The notification endpoint’s row, with the position header and body field and the ETag.

algoInstanceslist of objects

The algo instances the endpoint is sent events about; empty = every instance of the organisation. It narrows the events that name an instance: one that names none - the organisation-wide halt - is sent whatever this list holds. a repeating group served as an array of objects, in the group’s own order; empty = no entries, never null

approvalslist of objects

Who approved the row’s last proposal and when, in order. A proposal that waits concludes when the count reaches the organisation’s notifications approval rule, and never before one approval; the list is empty where the proposal concluded as it was made - its maker the organisation’s one member, or a deletion. a repeating group served as an array of objects, in the group’s own order; empty = no entries, never null

concludedTransitionenum

What the row’s last proposal proposed, kept once it concluded: ACTIVATE, AMEND or DELETE; NONE while it pends or when it was withdrawn. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. A consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
endpointIdinteger
Sticky entity key.
eventslist of enums

The event types the endpoint is sent; never empty. a set (SBE bit-set) served as the array of its published names, each a NotificationEvent, in declared order; empty = none set, never null; as input a repeated name refuses 400

Allowed values:
formatenum

What the destination is sent: SLACK is a Slack message, posted to a Slack incoming-webhook URL. UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

hoststring

The destination’s host name alone - no scheme, port or path - at most 253 characters of lowercase letters, digits, dot and hyphen.

lastWithdrawalReasonstring

Why the last proposal was withdrawn, as the withdrawer stated it; empty-not-null.

minSeverityenum

The least urgent event the endpoint is sent: INFO sends every event, WARNING leaves INFO out, CRITICAL sends CRITICAL alone. UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
namestring

The endpoint’s name, as its organisation lists it - 1 to 128 bytes of UTF-8.

orgIdinteger
The organisation the endpoint belongs to.
pendingTransitionenum

ACTIVATE or AMEND while a proposal waits for approval; NONE otherwise. While an AMEND waits, notifications are still sent as last approved. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. A consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
remarkstring

The maker’s note on the last proposal, for its approvers; empty-not-null. At most 256 bytes of UTF-8.

statusenum

PENDING_APPROVAL until the endpoint’s first proposal concludes - approved by another member, or made by the organisation’s one member - then ACTIVE, the one status notifications are sent in, then DELETED. A first proposal that was withdrawn leaves the row PENDING_APPROVAL with nothing pending. UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
updatedAtNsstringformat: "^-?[0-9]+$"
Platform time of this version. int64 as a decimal JSON string
updatedByobject

The member behind this version. an actor: an object {kind, id}

urlFingerprintstring

The destination URL’s fingerprint as the gateway computed it when the URL was stored - enough to tell two URLs apart, never enough to rebuild one: fp- and sixteen lowercase hexadecimal digits.

versionstringformat: "^-?[0-9]+$"

The row’s version - monotonic, bumped on every change. int64 as a decimal JSON string

concludedAtNsstring or nullOptionalformat: "^-?[0-9]+$"

Platform time the row’s last proposal concluded - equal to proposedAtNs where it concluded as it was made; 0 while it pends or when it was withdrawn. int64 as a decimal JSON string

concludedByobject or nullOptional

Who concluded it - the approver whose approval met the count, or the maker where it concluded as it was made; unstated when concludedAtNs is 0. an actor: an object {kind, id}; null where none is stated

lastWithdrawalAtNsstring or nullOptionalformat: "^-?[0-9]+$"

Platform time of that withdrawal; 0 when none was. int64 as a decimal JSON string

lastWithdrawalProposedByobject or nullOptional

Who made the last proposal that was withdrawn; unstated when none was. an actor: an object {kind, id}; null where none is stated

lastWithdrawalWithdrawnByobject or nullOptional

Who withdrew it - its maker, another member returning it, or the member whose deletion replaced it; unstated when none was. an actor: an object {kind, id}; null where none is stated

proposedAtNsstring or nullOptionalformat: "^-?[0-9]+$"
Platform time the row's last proposal was made. int64 as a decimal JSON string
proposedByobject or nullOptional

The maker of the row’s last proposal, kept after it concludes or is withdrawn - an approver is checked to be someone else while it pends. pendingTransition alone says whether a proposal pends. an actor: an object {kind, id}; null where none is stated

Errors

400
Get Endpoint Notifications Request Bad Request Error
401
Get Endpoint Notifications Request Unauthorized Error
403
Get Endpoint Notifications Request Forbidden Error
404
Get Endpoint Notifications Request Not Found Error
503
Get Endpoint Notifications Request Service Unavailable Error