Push

Update web push settings

Changed on

Enables or disables web push, or sets the default notification icon. The first enable generates the workspace's VAPID key pair; disabling keeps the keys so existing browser subscriptions remain valid when you enable again. Requires the integrations:manage scope and edit access to the workspace.

put/push/settings/web

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/push/settings/web
  • Auth
    HTTP bearer

Request body

enabledboolean

Turn web push on or off. Provide enabled and/or defaultIconUrl.

defaultIconUrlstring nullable

Default https icon used when a message has no icon. null or an empty string clears it.

Response

Updated settings

successboolean
siteKeyCreatedboolean

Returned when the request sets enabled to true. True when this request created the site key.

messagestring

Example response

{
  "success": true,
  "message": "Web push is enabled."
}

Changes