Lexicon Garden

social.colibri.beta.notification.registerPush

Registers a push endpoint for the requesting user's device. Web Push requires endpoint, p256dh, and auth. FCM requires token. APNs requires token and environment.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authoritynotification.beta.colibri.social
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

auth

string

The Web Push subscription's auth secret. Required when provider is webpush.

endpoint

string · uri

The Web Push subscription endpoint. Required when provider is webpush.

environment

string

The APNs environment the device token belongs to. Required when provider is apns.

  • knownValues: sandbox | production

p256dh

string

The Web Push subscription's p256dh key. Required when provider is webpush.

platform

requiredstring

The platform the device runs.

  • knownValues: web | ios | android | macos

provider

requiredstring

The push provider to register with.

  • knownValues: webpush | fcm | apns

token

string

The FCM registration token or the hex-encoded APNs device token. Required when provider is fcm or apns.

Output

application/json

Errors

AuthRequired

The request has no valid service auth.

InvalidRequest

The fields required for the given provider are missing or malformed.

PushNotConfigured

This AppView has no keypair for the requested provider.

Similar lexicons

semantic match

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