This API will retrieve the WebPush service options (W3C WebPush, IETF RFC 8030) for use with the HTML5/Javascript function PushManager.subscribe(options). This includes the VAPID (RFC 8292) authentication keys which allow for server-to-server authentication. The returned object is utilized to generate the values needed for invoking Register for WebPush Notifications.
Permissions
Requires a Permissions scope of: circle:notifications or circle:notifications_motion
Response Body
Name | Type | Description |
|---|---|---|
applicationServerKey | string | The base64 encoded Elliptic curve Diffie–Hellman public key on the P-256 curve used by the Circle servers for VAPID. |
userVisibleOnly | boolean | A boolean indicating that the returned push subscription will only be used for messages whose effect is made visible to the user. In Circle this is always false. |