\n\n## generateVAPIDKeys()\n\n```javascript\nconst vapidKeys = webpush.generateVAPIDKeys();\n\n// Prints 2 URL Safe Base64 Encoded Strings\nconsole.log(vapidKeys.publicKey, vapidKeys.privateKey);\n```\n\n### Input\n\nNone.\n\n### Returns\n\nReturns an object with **publicKey** and **privateKey** values which are\nURL Safe Base64 encoded strings.\n\n> **Note:** You should create these keys once, store them and use them for all\n> future messages you send.\n\n
\n\n## setGCMAPIKey(apiKey)\n\n```javascript\nwebpush.setGCMAPIKey('Your GCM API Key');\n```\n\n### Input\n\nThis method expects the GCM API key that is linked to the `gcm_sender_id ` in\nyour web app manifest.\n\nYou can use a GCM API Key from the Google Developer Console or the\n*Cloud Messaging* tab under a Firebase Project.\n\n### Returns\n\nNone.\n\n
\n\n## setVapidDetails(subject, publicKey, privateKey)\n\n```javascript\nwebpush.setVapidDetails(\n 'mailto:user@example.org',\n process.env.VAPID_PUBLIC_KEY,\n process.env.VAPID_PRIVATE_KEY\n);\n```\n\nGlobally sets the application's VAPID subject, public key, and private key, to be used in subsequent calls to `sendNotification()` and `generateRequestDetails()` that don't specifically override them in their `options` argument.\n\n### Input\n\nThe `setVapidDetails` method expects the following input:\n\n- *subject*: the VAPID server contact information, as either an `https:` or `mailto:` URI ([as per the VAPID spec](https://datatracker.ietf.org/doc/html/draft-thomson-webpush-vapid#section-2.1)).\n- *publicKey*: the VAPID public key.\n- *privateKey*: the VAPID private key.\n\n### Returns\n\nNone.\n\n
\n\n## encrypt(userPublicKey, userAuth, payload, contentEncoding)\n\n```javascript\nconst pushSubscription = {\n endpoint: 'https://....',\n keys: {\n p256dh: '.....',\n auth: '.....'\n }\n};\nwebPush.encrypt(\n pushSubscription.keys.p256dh,\n pushSubscription.keys.auth,\n 'My Payload',\n 'aes128gcm'\n)\n.then(encryptionDetails => {\n\n});\n```\n\nEncrypts the payload according to the [Message Encryption for Web\nPush](https://webpush-wg.github.io/webpush-encryption/) standard.\n\n> (*sendNotification* will automatically encrypt the payload for you, so if\n> you use *sendNotification* you don't need to worry about it).\n\n### Input\n\nThe `encrypt()` method expects the following input:\n\n- *userPublicKey*: the public key of the receiver (from the browser).\n- *userAuth*: the auth secret of the receiver (from the browser).\n- *payload*: the message to attach to the notification.\n- *contentEncoding*: the type of content encoding to use (e.g. aesgcm or aes128gcm).\n\n### Returns\n\nThis method returns an object with the following fields:\n\n- *localPublicKey*: The public key matched the private key used during\nencryption.\n- *salt*: A string representing the salt used to encrypt the payload.\n- *cipherText*: The encrypted payload as a Buffer.\n\n
\n\n## getVapidHeaders(audience, subject, publicKey, privateKey, contentEncoding, expiration)\n\n```javascript\nconst parsedUrl = url.parse(subscription.endpoint);\nconst audience = parsedUrl.protocol + '//' +\n parsedUrl.hostname;\n\nconst vapidHeaders = vapidHelper.getVapidHeaders(\n audience,\n 'mailto: example@web-push-node.org',\n vapidDetails.publicKey,\n vapidDetails.privateKey,\n 'aes128gcm'\n);\n```\n\nThe *getVapidHeaders()* method will take in the values needed to create\nan Authorization and Crypto-Key header.\n\n### Input\n\nThe `getVapidHeaders()` method expects the following input:\n\n- *audience*: the origin of the **push service**.\n- *subject*: the mailto or URL for your application.\n- *publicKey*: the VAPID public key.\n- *privateKey*: the VAPID private key.\n- *contentEncoding*: the type of content encoding to use (e.g. aesgcm or aes128gcm).\n\n### Returns\n\nThis method returns an object with the following fields:\n\n- *localPublicKey*: The public key matched the private key used during\nencryption.\n- *salt*: A string representing the salt used to encrypt the payload.\n- *cipherText*: The encrypted payload as a Buffer.\n\n
\n\n## generateRequestDetails(pushSubscription, payload, options)\n\n```javascript\nconst pushSubscription = {\n endpoint: '< Push Subscription URL >';\n keys: {\n p256dh: '< User Public Encryption Key >',\n auth: '< User Auth Secret >'\n }\n};\n\nconst payload = '< Push Payload String >';\n\nconst options = {\n gcmAPIKey: '< GCM API Key >',\n vapidDetails: {\n subject: '< \\'mailto\\' Address or URL >',\n publicKey: '< URL Safe Base64 Encoded Public Key >',\n privateKey: '< URL Safe Base64 Encoded Private Key >',\n }\n TTL:
\n\n# Browser Support\n\n
| Browser | \nPush without Payload | \nPush with Payload | \nVAPID | \nNotes | \n
|---|---|---|---|---|
| Chrome | \n\n\n✓ v42+ | \n\n\n✓ v50+ | \n\n\n✓ v52+ | \n\nIn v51 and less, the `gcm_sender_id` is needed to get a push subscription. | \n
| Edge | \n\n\n✓ v17+ (April 2018) | \n\n\n✓ v17+ (April 2018) | \n\n\n✓ v17+ (April 2018) | \n\n\n |
| Firefox | \n\n\n✓ v44+ | \n\n\n✓ v44+ | \n\n\n✓ v46+ | \n\n\n |
| Opera | \n\n\n✓ v39+ * | \n\n\n✓ v39+ * | \n\n\n✗ | \n\n\n * Opera supports push on Android but not on desktop.\n \n \n The `gcm_sender_id` is needed to get a push subscription.\n | \n
| Safari | \n\n\n✓ v16+ | \n\n\n✓ v16+ | \n\n\n✓ v16+ | \n\nSafari 16 in macOS 13 or later | \n
| Samsung Internet Browser | \n\n\n✓ v4.0.10-53+ | \n\n\n✓ v5.0.30-40+ | \n\n\n✗ | \n\nThe `gcm_sender_id` is needed to get a push subscription. | \n
\n \n ![](\"https://nodei.co/npm/web-push.svg?downloads=true\")
\n \n