![\"Notif.me\"](\"https://notifme.github.io/notifme-sdk/img/logo.png\"){kind=logo}
\n \n\n \n \n \n
\n A Node.js library to send all kinds of transactional notifications.\n
\n\n\n ![\"npm-status\"](\"https://img.shields.io/npm/v/notifme-sdk.svg?style=flat\")
\n \n
![\"license\"](\"https://img.shields.io/badge/license-MIT_License-blue.svg?style=flat\"){kind=icon}
\n ![\"slack\"](\"https://img.shields.io/badge/Slack-Join_us!-e01563.svg?style=flat\"){kind=icon}
\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'logger'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'smtp',\n host: 'smtp.example.com',\n port: 465,\n secure: true,\n auth: {\n user: 'xxxxx',\n pass: 'xxxxx'\n }\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'sendmail',\n sendmail: true,\n newline: 'unix',\n path: '/usr/sbin/sendmail'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'mailgun',\n apiKey: 'xxxxx',\n domainName: 'example.com'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'mandrill',\n apiKey: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'sendgrid',\n apiKey: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'ses',\n region: 'xxxxx',\n accessKeyId: 'xxxxx',\n secretAccessKey: 'xxxxx',\n sessionToken: 'xxxxx' // optional\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'sparkpost',\n apiKey: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n email: {\n providers: [{\n type: 'custom',\n id: 'my-custom-email-provider...',\n send: async (request) => {\n // Send email\n return 'id...'\n }\n }]\n }\n }\n})\n```\n\n`request` being of [the following type](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L8-L31).\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'logger'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: '46elks',\n apiUsername: 'xxxxx',\n apiPassword: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'callr',\n login: 'xxxxx',\n password: 'xxxxx'\n }]\n }\n }\n})\n```\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'clickatell',\n apiKey: 'xxxxx' // One-way integration API key\n }]\n }\n }\n})\n```\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'infobip',\n username: 'xxxxx',\n password: 'xxxxx'\n }]\n }\n }\n})\n```\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'nexmo',\n apiKey: 'xxxxx',\n apiSecret: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'ovh',\n appKey: 'xxxxx',\n appSecret: 'xxxxx',\n consumerKey: 'xxxxx',\n account: 'xxxxx',\n host: 'xxxxx' // https://github.com/ovh/node-ovh/blob/master/lib/endpoints.js\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'plivo',\n authId: 'xxxxx',\n authToken: 'xxxxx'\n }]\n }\n }\n})\n```\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'twilio',\n accountSid: 'xxxxx',\n authToken: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'seven',\n apiKey: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n sms: {\n providers: [{\n type: 'custom',\n id: 'my-custom-sms-provider...',\n send: async (request) => {\n // Send SMS\n return 'id...'\n }\n }]\n }\n }\n})\n```\n\n`request` being of [the following type](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L76-L92).\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n voice: {\n providers: [{\n type: 'logger'\n }]\n }\n }\n})\n```\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n voice: {\n providers: [{\n type: 'twilio',\n accountSid: 'xxxxx',\n authToken: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n voice: {\n providers: [{\n type: 'custom',\n id: 'my-custom-voice-provider...',\n send: async (request) => {\n // Send Voice\n return 'id...'\n }\n }]\n }\n }\n})\n```\n\n`request` being of [the following type](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L94-L111).\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n push: {\n providers: [{\n type: 'logger'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n push: {\n providers: [{\n type: 'apn',\n token: {\n key: './certs/key.p8',\n keyId: 'xxxxx',\n teamId: 'xxxxx'\n }\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n push: {\n providers: [{\n type: 'fcm',\n id: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n push: {\n providers: [{\n type: 'wns',\n clientId: 'xxxxx',\n clientSecret: 'xxxxx',\n notificationMethod: 'sendTileSquareBlock'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n push: {\n providers: [{\n type: 'adm',\n clientId: 'xxxxx',\n clientSecret: 'xxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n push: {\n providers: [{\n type: 'custom',\n id: 'my-custom-push-provider...',\n send: async (request) => {\n // Send push\n return 'id...'\n }\n }]\n }\n }\n})\n```\n\n`request` being of [the following type](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L33-L74).\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n webpush: {\n providers: [{\n type: 'logger'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n webpush: {\n providers: [{\n type: 'gcm',\n gcmAPIKey: 'xxxxx',\n vapidDetails: {\n subject: 'mailto: contact@example.com',\n publicKey: 'xxxxx',\n privateKey: 'xxxxx'\n }\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n webpush: {\n providers: [{\n type: 'custom',\n id: 'my-custom-webpush-provider...',\n send: async (request) => {\n // Send webpush\n return 'id...'\n }\n }]\n }\n }\n})\n```\n\n`request` being of [the following type](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L113-L134).\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n slack: {\n providers: [{\n type: 'logger'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n slack: {\n providers: [{\n type: 'webhook',\n webhookUrl: 'https://hooks.slack.com/services/Txxxxxxxx/Bxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx'\n }]\n }\n }\n})\n```\n\n
\n\n```javascript\nnew NotifmeSdk({\n channels: {\n slack: {\n providers: [{\n type: 'custom',\n id: 'my-custom-slack-provider...',\n send: async (request) => {\n // Send slack\n return 'id...'\n }\n }]\n }\n }\n})\n```\n\n`request` being of [the following type](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L136-L138).\n\n
\n\n```javascript\n/*\n * `providers` is an array containing all the instances that were\n * created from your configuration.\n */\nconst randomStrategy = (providers) => async (request) => {\n // Choose one provider at random\n const provider = providers[Math.floor(Math.random() * providers.length)];\n\n try {\n const id = await provider.send(request)\n return {id, providerId: provider.id}\n } catch (error) {\n error.providerId = provider.id\n throw error\n }\n}\n\nnew NotifmeSdk({\n channels: {\n email: { // Example for email channel\n providers: [...],\n multiProviderStrategy: randomStrategy\n }\n }\n})\n```\n
\n\n```javascript\nimport strategyFallback from 'notifme-sdk/lib/strategies/fallback'\n\nfunction getCountryFromNumber(number) {\n // extract the country from a phone number (+33670707070) -> 'fr'\n}\nfunction orderProvidersByPrice(country, providers) {\n // giving a country return an array of ordered providers by price\n}\n\nconst smsCheapStrategy = (providers) => async (request) => {\n const country = getCountryFromNumber(request.from)\n const providersOrdered = orderProvidersByPrice(country, providers)\n\n return strategyFallback(providersOrdered)(request)\n}\n```\n
\n\n```\nnew NotifmeSdk({\n channels: {\n socket: {\n multiProviderStrategy: 'fallback',\n providers: [\n {\n type: 'custom',\n id: 'my-socket-sender',\n send: async () => {\n return 'custom-socket-id'\n }\n }\n ]\n }\n }\n})\n```\n\n
\n\n```javascript\nnotifmeSdk.send({\n email: {\n from: 'me@example.com',\n to: 'john@example.com',\n subject: 'Hi John',\n html: 'Hello John! How are you?'\n }\n})\n```\n\nSee [all parameters](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L8).\n\n
\n\n```javascript\nnotifmeSdk.send({\n sms: {\n from: '+15000000000',\n to: '+15000000001',\n text: 'Hello John! How are you?'\n }\n})\n```\n\nSee [all parameters](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L76).\n\n
\n\n```javascript\nnotifmeSdk.send({\n voice: {\n from: '+15000000000',\n to: '+15000000001',\n url: 'http://demo.twilio.com/docs/voice.xml'\n }\n})\n```\n\nSee [all parameters](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L94).\n\n
\n\n```javascript\nnotifmeSdk.send({\n push: {\n registrationToken: 'xxxxx',\n title: 'Hi John',\n body: 'Hello John! How are you?',\n icon: 'https://notifme.github.io/notifme-sdk/img/icon.png'\n }\n})\n```\n\nSee [all parameters](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L33).\n\n
\n\n```javascript\nnotifmeSdk.send({\n webpush: {\n subscription: {\n keys: {\n auth: 'xxxxx',\n p256dh: 'xxxxx'\n },\n endpoint: 'xxxxx'\n },\n title: 'Hi John',\n body: 'Hello John! How are you?',\n icon: 'https://notifme.github.io/notifme-sdk/img/icon.png'\n }\n})\n```\n\nSee [all parameters](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L109).\n\n
\n\n```javascript\nnotifmeSdk.send({\n slack: {\n text: 'Slack webhook text'\n }\n})\n```\n\nSee [all parameters](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L132).\n\n
\n\n```javascript\nnotifmeSdk.send({\n email: {\n from: 'me@example.com',\n to: 'john@example.com',\n subject: 'Hi John',\n html: 'Hello John! How are you?'\n },\n sms: {\n from: '+15000000000',\n to: '+15000000001',\n text: 'Hello John! How are you?'\n },\n push: {\n registrationToken: 'xxxxx',\n title: 'Hi John',\n body: 'Hello John! How are you?',\n icon: 'https://notifme.github.io/notifme-sdk/img/icon.png'\n },\n webpush: {\n subscription: {\n keys: {\n auth: 'xxxxx',\n p256dh: 'xxxxx'\n },\n endpoint: 'xxxxx'\n },\n title: 'Hi John',\n body: 'Hello John! How are you?',\n icon: 'https://notifme.github.io/notifme-sdk/img/icon.png'\n },\n slack: {\n text: 'Slack webhook text'\n }\n})\n```\n\nSee [all parameters](https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js).\n\n
\n \n ![\"Notif.me](\"https://notifme.github.io/notifme-history/img/logo.png\"){kind=logo}
\n \n
\n A pretty history of the conversations with your users.\n