Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Sylphx Broker: Connections

A Connection is a third-party relationship: a provider installation, or Web Push assertion configuration backed by a generated Sylphx Keys…

A Connection is a third-party relationship: a provider installation, or Web Push assertion configuration backed by a generated Sylphx Keys key. The Connections controller validates its configuration before it is Ready.

Service Sylphx Broker · Resource type connections.sylphx.com/Connection · Name pattern orgs/{org}/connections/{connection} · Shape spec_status

#Fields

FieldTypeWhat it is
namestringorgs/{org}/connections/{connection}.
uidstringcnx_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specConnectionSpecDesired state. Required.
statusConnectionStatusObserved state. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
POSTsign_vapid_assertionSigns an RFC 8292 assertion using a committed same-org Web Push Connection. The stored contact supplies the subject; an ordinary caller must hold broker:exchange on this exact Connection and satisfy its TrustPolicy.

#sign_vapid_assertion

Signs an RFC 8292 assertion using a committed same-org Web Push Connection. The stored contact supplies the subject; an ordinary caller must hold broker:exchange on this exact Connection and satisfy its TrustPolicy.

POST https://api.sylphx.com/v1/orgs/acme/connections/connection:signVapidAssertion · scope broker:exchange · effect read · Request, response and examples