web-push

The getVapidHeaders() method generates the Authorization and Crypto-Key headers required for VAPID-authenticated push requests.

Input

• audience: The origin of the push service (e.g., https://fcm.googleapis.com).
• subject: A mailto: address or a URL for your application.
• publicKey: The VAPID public key.
• privateKey: The VAPID private key.
• contentEncoding: The type of content encoding to use (e.g., aesgcm or aes128gcm).

Returns

An object containing:

• localPublicKey: The public key matched to the private key used.
• salt: A string representing the salt used for encryption.
• cipherText: The encrypted payload as a Buffer.

const parsedUrl = url.parse(subscription.endpoint);
const audience = parsedUrl.protocol + '//' +
  parsedUrl.hostname;

const vapidHeaders = vapidHelper.getVapidHeaders(
  audience,
  'mailto: example@web-push-node.org',
  vapidDetails.publicKey,
  vapidDetails.privateKey,
  'aes128gcm'
);

The generateRequestDetails() method prepares all the necessary components (endpoint, method, headers, and body) to perform a network request to a push service.

Input

1. pushSubscription

An object containing the subscription details. It should match the format of a PushSubscription object serialized via JSON.stringify() in a browser.

2. payload (Optional)

A string or Node.js Buffer. If provided, it will be encrypted. To encrypt a payload, the pushSubscription must include a keys object with p256dh and auth values. Passing null will return no body and exclude unnecessary headers.

3. options (Optional)

An object containing:

• gcmAPIKey: A GCM API key for this specific request.
• vapidDetails: An object with subject, publicKey, and privateKey (following the VAPID Spec).
• TTL: Time-to-live in seconds.
• headers: An object of extra headers to add.
• contentEncoding: Encoding type (e.g., 'aesgcm' or 'aes128gcm').
• urgency: Delivery priority (very-low, low, normal, or high).
• topic: A unique identifier (max 32 characters) for notification coalescing.
• proxy: Configuration for an HttpsProxyAgent (string URI or options object).

Returns

An object containing:

• endpoint: The URL to send the request to.
• method: Always 'POST'.
• headers: The headers to include in the request.
• body: The request body as a Node.js Buffer.

const pushSubscription = {
  endpoint: '< Push Subscription URL >',
  keys: {
    p256dh: '< User Public Encryption Key >',
    auth: '< User Auth Secret >'
  }
};

const payload = '< Push Payload String >';

const options = {
  gcmAPIKey: '< GCM API Key >',
  vapidDetails: {
    subject: '< \'mailto\' Address or URL >',
    publicKey: '< URL Safe Base64 Encoded Public Key >',
    privateKey: '< URL Safe Base64 Encoded Private Key >',
  },
  TTL: <Number>,
  headers: {
    '< header name >': '< header value >'
  },
  contentEncoding: '< Encoding type, e.g.: aesgcm or aes128gcm >',
  urgency:'< Default is normal "Defult" >',
  topic:'< Use a maximum of 32 characters from the URL or filename-safe Base64 characters sets. >',
  proxy: '< proxy server options >'
}

try {
  const details = webpush.generateRequestDetails(
    pushSubscription,
    payload,
    options
  );
} catch (err) {
  console.error(err);
}

The following flags are available for the web-push send-notification command:

web-push send-notification  \
--endpoint=https://fcm.googleapis.com/fcm/send/d61c5u920dw:APA91bEmnw8utjDYCqSRplFMVCzQMg9e5XxpYajvh37mv2QIlISdasBFLbFca9ZZ4Uqcya0ck-SP84YJUEnWsVr3mwYfaDB7vGtsDQuEpfDdcIqOX_wrCRkBW2NDWRZ9qUz9hSgtI3sY \
--key=BL7ELU24fJTAlH5Kyl8N6BDCac8u8li_U5PIwG963MOvdYs9s7LSzj8x_7v7RFdLZ9Eap50PiiyF5K0TDAis7t0 \
--auth=juarI8x__VnHvsOgfeAPHg \
--vapid-subject=mailto:example@qq.com \
--vapid-pubkey=BGtkbcjrO12YMoDuq2sCQeHlu47uPx3SHTgFKZFYiBW8Qr0D9vgyZSZPdw6_4ZFEI9Snk1VEAj2qTYI1I1YxBXE \
--vapid-pvtkey=I0_d0vnesxbBSUmlDdOKibGo6vEXRO-Vu88QlSlm5j0 \
--payload=Hello